Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 2.84 KB

README.md

File metadata and controls

108 lines (76 loc) · 2.84 KB

cliproxyapi-plusplus

Agent-native, multi-provider OpenAI-compatible proxy for production and local model routing.

This is the Plus version of cliproxyapi-plusplus, adding support for third-party providers on top of the mainline project.

All third-party provider support is maintained by community contributors; cliproxyapi-plusplus does not provide technical support. Please contact the corresponding community maintainer if you need assistance.

Key Features

  • OpenAI-compatible request surface across heterogeneous providers.
  • Unified auth and token handling for OpenAI, Anthropic, Gemini, Kiro, Copilot, and more.
  • Provider-aware routing and model conversion.
  • Built-in operational tooling for management APIs and diagnostics.

Architecture

  • cmd/server: primary API server entrypoint.
  • cmd/cliproxyctl: operational CLI.
  • internal/: runtime/auth/translator internals.
  • pkg/llmproxy/: reusable proxy modules.
  • sdk/: SDK-facing interfaces.

Getting Started

Prerequisites

  • Go 1.24+
  • Docker (optional)
  • Provider credentials for target upstreams

Quick Start

# Create deployment directory
mkdir -p ~/cli-proxy && cd ~/cli-proxy

# Create docker-compose.yml
cat > docker-compose.yml << 'EOF'
services:
  cli-proxy-api:
    image: eceasy/cli-proxy-api-plus:latest
    container_name: cli-proxy-api-plus
    ports:
      - "8317:8317"
    volumes:
      - ./config.yaml:/CLIProxyAPI/config.yaml
      - ./auths:/root/.cli-proxy-api
      - ./logs:/CLIProxyAPI/logs
    restart: unless-stopped
EOF

# Download example config
curl -o config.yaml https://raw.githubusercontent.com/kooshapari/cliproxyapi-plusplus/main/config.example.yaml

# Pull and start
docker compose pull && docker compose up -d

Docker Quick Start

docker run -p 8317:8317 eceasy/cli-proxy-api-plus:latest

Operations and Security

  • Rate limiting and quota/cooldown controls.
  • Auth flows for provider-specific OAuth/API keys.
  • CI policy checks and path guards.
  • Governance and security docs under docs/operations/ and docs/reference/.

Testing and Quality

go test ./...

Quality gates are enforced via repo CI workflows (build/lint/path guards).

Documentation

Primary docs root is docs/ with a unified category IA:

  • docs/wiki/
  • docs/development/
  • docs/index/
  • docs/api/
  • docs/roadmap/

VitePress docs commands:

cd docs
npm install
npm run docs:dev
npm run docs:build

Contributing

This project only accepts pull requests that relate to third-party provider support. Any pull requests unrelated to third-party provider support will be rejected.

If you need to submit any non-third-party provider changes, please open them against the mainline repository.

License

MIT License. See LICENSE.