Update README again
Browse files- README.md +36 -6
- assets/how-it-works.mmd +2 -2
- assets/how-it-works.svg +0 -0
README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
| 2 |
|
| 3 |
# 馃 Free Claude Code
|
| 4 |
|
| 5 |
-
Use Claude Code CLI, Codex CLI, VS Code, JetBrains ACP, or chat bots through your own provider-backed proxy.
|
| 6 |
|
| 7 |
[](https://opensource.org/licenses/MIT)
|
| 8 |
[](https://www.python.org/downloads/)
|
|
@@ -12,7 +12,7 @@ Use Claude Code CLI, Codex CLI, VS Code, JetBrains ACP, or chat bots through you
|
|
| 12 |
[](https://github.com/astral-sh/ruff)
|
| 13 |
[](https://github.com/Delgan/loguru)
|
| 14 |
|
| 15 |
-
Free Claude Code routes Anthropic Messages API traffic from Claude Code and OpenAI Responses API traffic from Codex to any provider. It keeps each client's protocol stable while letting you choose free, paid, or local models through the same proxy and Admin UI.
|
| 16 |
|
| 17 |
[Quick Start](#quick-start) 路 [Providers](#choose-a-provider) 路 [Clients](#connect-your-client) 路 [Integrations](#optional-integrations) 路 [Development](#development)
|
| 18 |
|
|
@@ -50,7 +50,8 @@ Free Claude Code routes Anthropic Messages API traffic from Claude Code and Open
|
|
| 50 |
- Native Claude Code `/model` picker support through the proxy's `/v1/models` endpoint (see [Model Picker](#model-picker)).
|
| 51 |
- Streaming, tool use, reasoning/thinking block handling, and local request optimizations.
|
| 52 |
- Optional Discord or Telegram bot wrapper for remote Claude Code sessions.
|
| 53 |
-
- Optional Usage through the
|
|
|
|
| 54 |
- Optional voice-note transcription through local Whisper or NVIDIA NIM.
|
| 55 |
- Local **Admin UI** at `/admin` to edit supported proxy settings, validate changes, and check providers (loopback access only).
|
| 56 |
|
|
@@ -373,7 +374,7 @@ Set `FCC_CODEX_API_KEY` to the same value as `ANTHROPIC_AUTH_TOKEN` in the Admin
|
|
| 373 |
|
| 374 |
### 3. Claude Code in VS Code
|
| 375 |
|
| 376 |
-
Open Settings, search for `claude-code.environmentVariables`, choose **Edit in settings.json**, and add:
|
| 377 |
|
| 378 |
```json
|
| 379 |
"claudeCode.environmentVariables": [
|
|
@@ -386,7 +387,36 @@ Open Settings, search for `claude-code.environmentVariables`, choose **Edit in s
|
|
| 386 |
|
| 387 |
Reload the extension. If the extension shows a login screen, choose the Anthropic Console path once; the local proxy still handles model traffic after the environment variables are active.
|
| 388 |
|
| 389 |
-
### 4.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 390 |
|
| 391 |
Edit the installed Claude ACP config:
|
| 392 |
|
|
@@ -412,7 +442,7 @@ For every integration below, change **managed proxy settings** only in the **Adm
|
|
| 412 |
|
| 413 |
### 1. Discord And Telegram Bots
|
| 414 |
|
| 415 |
-
The bot wrapper runs Claude Code sessions remotely, streams progress, supports reply-based conversation branches, and can stop or clear tasks. Discord and Telegram bots use Claude Code today; use `fcc-codex`
|
| 416 |
|
| 417 |
**Discord**
|
| 418 |
|
|
|
|
| 2 |
|
| 3 |
# 馃 Free Claude Code
|
| 4 |
|
| 5 |
+
Use Claude Code CLI, Codex CLI, their VS Code extensions, JetBrains ACP, or chat bots through your own provider-backed proxy.
|
| 6 |
|
| 7 |
[](https://opensource.org/licenses/MIT)
|
| 8 |
[](https://www.python.org/downloads/)
|
|
|
|
| 12 |
[](https://github.com/astral-sh/ruff)
|
| 13 |
[](https://github.com/Delgan/loguru)
|
| 14 |
|
| 15 |
+
Free Claude Code routes Anthropic Messages API traffic from Claude Code (CLI and VS Code extension) and OpenAI Responses API traffic from Codex (CLI and VS Code extension) to any provider. It keeps each client's protocol stable while letting you choose free, paid, or local models through the same proxy and Admin UI.
|
| 16 |
|
| 17 |
[Quick Start](#quick-start) 路 [Providers](#choose-a-provider) 路 [Clients](#connect-your-client) 路 [Integrations](#optional-integrations) 路 [Development](#development)
|
| 18 |
|
|
|
|
| 50 |
- Native Claude Code `/model` picker support through the proxy's `/v1/models` endpoint (see [Model Picker](#model-picker)).
|
| 51 |
- Streaming, tool use, reasoning/thinking block handling, and local request optimizations.
|
| 52 |
- Optional Discord or Telegram bot wrapper for remote Claude Code sessions.
|
| 53 |
+
- Optional Usage through the Claude Code VS Code extension.
|
| 54 |
+
- Codex CLI and VS Code extension support through the shared `~/.codex/config.toml` provider config.
|
| 55 |
- Optional voice-note transcription through local Whisper or NVIDIA NIM.
|
| 56 |
- Local **Admin UI** at `/admin` to edit supported proxy settings, validate changes, and check providers (loopback access only).
|
| 57 |
|
|
|
|
| 374 |
|
| 375 |
### 3. Claude Code in VS Code
|
| 376 |
|
| 377 |
+
Install the [Claude Code extension](https://marketplace.visualstudio.com/items?itemName=anthropic.claude-code). Open Settings, search for `claude-code.environmentVariables`, choose **Edit in settings.json**, and add:
|
| 378 |
|
| 379 |
```json
|
| 380 |
"claudeCode.environmentVariables": [
|
|
|
|
| 387 |
|
| 388 |
Reload the extension. If the extension shows a login screen, choose the Anthropic Console path once; the local proxy still handles model traffic after the environment variables are active.
|
| 389 |
|
| 390 |
+
### 4. Codex in VS Code
|
| 391 |
+
|
| 392 |
+
Install the [Codex extension](https://marketplace.visualstudio.com/items?itemName=openai.chatgpt). The extension shares the same user-level Codex config as the CLI (`~/.codex/config.toml` on macOS/Linux, `%USERPROFILE%\.codex\config.toml` on Windows).
|
| 393 |
+
|
| 394 |
+
Create or edit that file with the `fcc` provider pointing at your local proxy:
|
| 395 |
+
|
| 396 |
+
```toml
|
| 397 |
+
model_provider = "fcc"
|
| 398 |
+
model = "nvidia_nim/nvidia/nemotron-3-super-120b-a12b"
|
| 399 |
+
|
| 400 |
+
[model_providers.fcc]
|
| 401 |
+
name = "Free Claude Code"
|
| 402 |
+
base_url = "http://127.0.0.1:8082/v1"
|
| 403 |
+
env_key = "FCC_CODEX_API_KEY"
|
| 404 |
+
wire_api = "responses"
|
| 405 |
+
```
|
| 406 |
+
|
| 407 |
+
Set `model` to your Admin UI `MODEL` value. Replace `8082` if your proxy uses a different `PORT`.
|
| 408 |
+
|
| 409 |
+
Store the proxy auth token in `~/.codex/auth.json` (or the Windows equivalent):
|
| 410 |
+
|
| 411 |
+
```json
|
| 412 |
+
{
|
| 413 |
+
"FCC_CODEX_API_KEY": "freecc"
|
| 414 |
+
}
|
| 415 |
+
```
|
| 416 |
+
|
| 417 |
+
Use the same value as `ANTHROPIC_AUTH_TOKEN` in the Admin UI. Restart VS Code after changing these files. On Windows with WSL-backed Codex, edit the WSL `~/.codex/` files instead and enable `chatgpt.runCodexInWindowsSubsystemForLinux` in VS Code settings when needed.
|
| 418 |
+
|
| 419 |
+
### 5. Claude Code in JetBrains ACP
|
| 420 |
|
| 421 |
Edit the installed Claude ACP config:
|
| 422 |
|
|
|
|
| 442 |
|
| 443 |
### 1. Discord And Telegram Bots
|
| 444 |
|
| 445 |
+
The bot wrapper runs Claude Code sessions remotely, streams progress, supports reply-based conversation branches, and can stop or clear tasks. Discord and Telegram bots use Claude Code today; use `fcc-codex` or the Codex VS Code extension for Codex sessions.
|
| 446 |
|
| 447 |
**Discord**
|
| 448 |
|
assets/how-it-works.mmd
CHANGED
|
@@ -1,7 +1,7 @@
|
|
| 1 |
%%{init: {"theme": "base", "themeVariables": {"fontFamily": "Inter, ui-sans-serif, system-ui, Segoe UI, Arial", "background": "transparent", "primaryTextColor": "#172033", "lineColor": "#718096"}}}%%
|
| 2 |
flowchart LR
|
| 3 |
-
claudeClient(["Claude Code<br/>CLI /
|
| 4 |
-
codexClient(["Codex CLI"])
|
| 5 |
messagesApi["Anthropic API<br/>/v1/messages, /v1/models"]
|
| 6 |
responsesApi["OpenAI Responses API<br/>/v1/responses"]
|
| 7 |
|
|
|
|
| 1 |
%%{init: {"theme": "base", "themeVariables": {"fontFamily": "Inter, ui-sans-serif, system-ui, Segoe UI, Arial", "background": "transparent", "primaryTextColor": "#172033", "lineColor": "#718096"}}}%%
|
| 2 |
flowchart LR
|
| 3 |
+
claudeClient(["Claude Code<br/>CLI / VS Code / JetBrains / Bots"])
|
| 4 |
+
codexClient(["Codex CLI<br/>VS Code extension"])
|
| 5 |
messagesApi["Anthropic API<br/>/v1/messages, /v1/models"]
|
| 6 |
responsesApi["OpenAI Responses API<br/>/v1/responses"]
|
| 7 |
|
assets/how-it-works.svg
CHANGED
|
|
|
|