Skip to content

docs: lead Install with ./install.sh; recommend claudius wrapper function #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
opencolin wants to merge 2 commits into from
Closed

docs: lead Install with ./install.sh; recommend claudius wrapper function #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72fefdf
docs: lead Install with ./install.sh; recommend claudius wrapper func…
Apr 30, 2026
9ec72fc
docs: drop "recommended" framing from "Use with Claude Code"
Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 42 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,31 @@ claude-code-proxy/

### Install

Using `uv`:
The fastest path is the bundled installer, which creates a virtualenv,
installs runtime dependencies, prompts for your Nebius API key without
echoing it to your shell, validates the configured model IDs against
`GET /v1/models`, and runs an end-to-end smoke test before declaring
success:

```bash
uv sync
./install.sh
```

Using `pip`:
#### Manual install

If you'd rather wire things up yourself:

```bash
python -m pip install -e ".[dev]"
python -m venv .venv
.venv/bin/python -m pip install --upgrade pip # fresh venvs ship pip <22 which fails on pyproject editable installs
.venv/bin/pip install -r requirements.txt
cp .env.example .env # then edit .env to set OPENAI_API_KEY
```

Or with `uv`:

```bash
uv sync
```

### Configure
Expand Down Expand Up @@ -101,10 +116,32 @@ uv run claude-code-proxy-nebius

### Use with Claude Code

Pick one of these patterns and add it to your shell rc (`~/.zshrc` or
`~/.bashrc`), then open a new shell:

**Option A — separate command.** Bare `claude` keeps using Anthropic; a
named alias (here, `claudius`) routes through this proxy. The env vars
exist only for the duration of that invocation, so there's no hidden
shell state.

```bash
ANTHROPIC_BASE_URL="http://localhost:8083" ANTHROPIC_API_KEY="any-value" claude
claudius() {
ANTHROPIC_BASE_URL=http://localhost:8083 ANTHROPIC_API_KEY=claude-local claude "$@"
}
```

**Option B — global exports.** Every `claude` invocation routes through
the proxy; convenient if you mostly use Claude Code with this proxy.

```bash
export ANTHROPIC_BASE_URL=http://localhost:8083
export ANTHROPIC_API_KEY=claude-local
```

Option A keeps the provider visible in the command name. Option B is
fewer keystrokes per invocation. The bundled `install.sh` can write
either snippet for you at the end of install.

If `IGNORE_CLIENT_API_KEY=false`, the client key must match `ANTHROPIC_API_KEY`.

## MCP Support
Expand Down
Loading