Run with Docker Compose

Clone the repository and navigate into the directory:

bash

git clone https://github.com/luispater/CLIProxyAPI.git
cd CLIProxyAPI

Prepare the configuration file: Create a config.yaml file by copying the example and customize it to your needs.

bash

cp config.example.yaml config.yaml

(Note for Windows users: You can use copy config.example.yaml config.yaml in CMD or PowerShell.)

To use the Git-backed configuration store, you can add the GITSTORE_* environment variables to your docker-compose.yml file under the cli-proxy-api service definition. For example:

yaml

services:
  cli-proxy-api:
    image: eceasy/cli-proxy-api:latest
    container_name: cli-proxy-api
    ports:
      - "8317:8317"
      - "8085:8085"
      - "1455:1455"
      - "54545:54545"
      - "11451:11451"
    environment:
      - GITSTORE_GIT_URL=https://github.com/your/config-repo.git
      - GITSTORE_GIT_TOKEN=your_personal_access_token
    volumes:
      - ./git-store:/CLIProxyAPI/remote # GITSTORE_LOCAL_PATH
    restart: unless-stopped

When using the Git store, you may not need to mount config.yaml or auth-dir directly.

Start the service:
- For most users (recommended): Run the following command to start the service using the pre-built image from Docker Hub. The service will run in the background.
  bash
```
docker compose up -d
```
- For advanced users: If you have modified the source code and need to build a new image, use the interactive helper scripts:
  - For Windows (PowerShell):
    powershell
```
.\docker-build.ps1
```
  - For Linux/macOS:
    bash
```
bash docker-build.sh
```
  The script will prompt you to choose how to run the application:
  - Option 1: Run using Pre-built Image (Recommended): Pulls the latest official image from the registry and starts the container. This is the easiest way to get started.
  - Option 2: Build from Source and Run (For Developers): Builds the image from the local source code, tags it as cli-proxy-api:local, and then starts the container. This is useful if you are making changes to the source code.

To authenticate with providers, run the login command inside the container:

Gemini:

bash

docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --login

OpenAI (Codex):

bash

docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --codex-login

Claude:

bash

docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --claude-login

Qwen:

bash

docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --qwen-login

iFlow:

bash

docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --iflow-login

To view the server logs:
bash
```
docker compose logs -f
```
To stop the application:
bash
```
docker compose down
```

Run with Docker Compose ​

Run with Docker Compose