diff --git a/README.md b/README.md index bb321387..8d15f683 100644 --- a/README.md +++ b/README.md @@ -497,30 +497,36 @@ docker run --rm -p 8317:8317 -v /path/to/your/config.yaml:/CLIProxyAPI/config.ya ## Run with Docker Compose -1. Create a `config.yaml` from `config.example.yaml` and customize it. +1. Clone the repository: + ```bash + git clone https://github.com/luispater/CLIProxyAPI.git + cd CLIProxyAPI + ``` -2. Build and start the services using the build scripts: +2. Create a `config.yaml` from `config.example.yaml` and customize it. + +3. Build and start the services using the build scripts: - For Windows (PowerShell): ```powershell - ./docker-build.ps1 + .\docker-build.ps1 ``` - For Linux/macOS: ```bash bash docker-build.sh ``` -3. To authenticate with providers, run the login command inside the container: +4. To authenticate with providers, run the login command inside the container: - **Gemini**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --login` - **OpenAI (Codex)**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --codex-login` - **Claude**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --claude-login` - **Qwen**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --qwen-login` -4. To view the server logs: +5. To view the server logs: ```bash docker compose logs -f ``` -5. To stop the application: +6. To stop the application: ```bash docker compose down ``` diff --git a/README_CN.md b/README_CN.md index e4023f3c..862926c6 100644 --- a/README_CN.md +++ b/README_CN.md @@ -512,30 +512,36 @@ docker run --rm -p 8317:8317 -v /path/to/your/config.yaml:/CLIProxyAPI/config.ya ## 使用 Docker Compose 运行 -1. 从 `config.example.yaml` 创建一个 `config.yaml` 文件并进行自定义。 +1. 克隆仓库: + ```bash + git clone https://github.com/luispater/CLIProxyAPI.git + cd CLIProxyAPI + ``` -2. 使用构建脚本构建并启动服务: +2. 从 `config.example.yaml` 创建一个 `config.yaml` 文件并进行自定义。 + +3. 使用构建脚本构建并启动服务: - Windows (PowerShell): ```powershell - ./docker-build.ps1 + .\docker-build.ps1 ``` - Linux/macOS: ```bash bash docker-build.sh ``` -3. 要在容器内运行登录命令进行身份验证: +4. 要在容器内运行登录命令进行身份验证: - **Gemini**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --login` - **OpenAI (Codex)**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --codex-login` - **Claude**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --claude-login` - **Qwen**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --qwen-login` -4. 查看服务器日志: +5. 查看服务器日志: ```bash docker compose logs -f ``` -5. 停止应用程序: +6. 停止应用程序: ```bash docker compose down ```