mirror of
https://github.com/dtzp555-max/ocp.git
synced 2026-07-19 09:44:07 +00:00
docs: restructure README (1205 → 497 lines) — ops-manual content moves to docs/ (#172)
Maintainer-approved P2 restructure. Principle: what a new user needs in the first
10 minutes stays in README; the operations manual moves to docs/. Content MOVED,
not rewritten — an independent verifier swept all 20 original sections, 60+
distinctive facts, and all table rows against the new corpus: zero content loss.
New files (verbatim moves + two mandated dedup merges):
- docs/lan-mode.md (396) — LAN setup, key management, quotas, anonymous access,
deployment/security model + honest limits, client connect
- docs/tui-mode.md (196) — full TUI section + the four giant env-cell essays as
prose subsections; opens with the single-user SECURITY
warning + the PAUSED billing-split status banner
- docs/troubleshooting.md (136) — full troubleshooting; canonical 401/credential-
isolation explanation (union of the 4 prior copies)
- docs/upgrading.md (79) — upgrade paths, snapshots, rollback, auto-sync
README keeps: pitch (byte-identical), new TOC, 62-line Quickstart, How It Works
verbatim (incl. #171 billing-status note + workload fit), the three release_kit-
pinned tables (Available Models / API Endpoints / all 37 Environment Variables
rows — 4 giant TUI cells now one-line pointers), All Commands, slim Troubleshooting
(bootstrap quirks retained per release_kit bootstrap_quirk_policy), summary stubs
linking each moved doc, Repository Layout (+4 doc rows), Governance, Support.
Dedup (canonical copies): sdk-cli vs subscription-pool table → docs/tui-mode.md;
credential-isolated-home / permanent-401 → docs/troubleshooting.md#tui-401.
Link retargets: docs/runbooks/615-canary.md, docs/runbooks/tui-flip-rollback.md,
setup.mjs (one banner string; node --check clean). 126 links across the touched
files verified resolving; repo-wide grep shows no reference to a removed anchor.
npm test: 332 passed / 0 failed.
Co-authored-by: dtzp555 <dtzp555@gmail.com>
Co-authored-by: Claude <claude-opus-4-8> <noreply@anthropic.com>
This commit is contained in:
dtzp555-max
@@ -0,0 +1,396 @@
|
|||||||
|
Part of [OCP](../README.md) — LAN & multi-user: server setup, client connect, API-key management, per-key quotas, anonymous access, and the deployment/security model (including the honest limits of sharing).
|
||||||
|
|
||||||
|
# LAN & multi-user
|
||||||
|
|
||||||
|
OCP has two roles: **Server** (runs the proxy, needs Claude CLI) and **Client** (connects to a server, zero dependencies).
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─ Server (always-on device) ─────────────────────────────┐
|
||||||
|
│ Mac mini / NAS / Raspberry Pi / Desktop │
|
||||||
|
│ Claude CLI + OCP server → bound to 0.0.0.0:3456 │
|
||||||
|
└───────────────────────┬─────────────────────────────────┘
|
||||||
|
│ LAN
|
||||||
|
┌───────────────────┼───────────────────┐
|
||||||
|
▼ ▼ ▼
|
||||||
|
Laptop Phone/Tablet Pi / Server
|
||||||
|
(client) (browser) (client)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Server Setup
|
||||||
|
|
||||||
|
> **Recommended:** Install OCP on a device that stays powered on — Mac mini, NAS, Raspberry Pi, or a desktop that doesn't sleep. This ensures all clients always have access.
|
||||||
|
|
||||||
|
**Prerequisites:**
|
||||||
|
- macOS or Linux (Windows is not supported — `setup.mjs` installs launchd / systemd auto-start)
|
||||||
|
- Node.js 22.5+ (Node 23+ recommended — `node:sqlite` is fully stable without flags from 23.0; on 22.5–22.x it works behind `--experimental-sqlite`)
|
||||||
|
- `git`
|
||||||
|
- [Claude CLI](https://docs.anthropic.com/en/docs/claude-cli) — install and authenticate:
|
||||||
|
```bash
|
||||||
|
npm install -g @anthropic-ai/claude-code
|
||||||
|
claude auth login # prints a URL + code — open URL on any browser, sign in, paste code back
|
||||||
|
```
|
||||||
|
Headless servers (Pi / NAS / VPS without a desktop browser): see [Headless install notes](#headless-install-notes) below.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. Clone and run setup
|
||||||
|
git clone https://github.com/dtzp555-max/ocp.git
|
||||||
|
cd ocp
|
||||||
|
node setup.mjs
|
||||||
|
```
|
||||||
|
|
||||||
|
The setup script will:
|
||||||
|
1. Verify Claude CLI is installed and authenticated
|
||||||
|
2. Start the proxy on port 3456
|
||||||
|
3. Install auto-start (launchd on macOS, systemd on Linux)
|
||||||
|
|
||||||
|
After install the `ocp` CLI lives at `~/ocp/ocp`. To put it on your PATH, either symlink it manually (`ln -sf ~/ocp/ocp ~/.local/bin/ocp` if `~/.local/bin` is on your PATH, or `sudo ln -sf ~/ocp/ocp /usr/local/bin/ocp` for a system-wide symlink) or add an alias (`alias ocp=~/ocp/ocp`). Otherwise invoke it as `~/ocp/ocp <subcommand>`. The rest of this document assumes `ocp` is on your PATH.
|
||||||
|
|
||||||
|
> **Cloud/Linux servers:** If `ocp: command not found` after a cloud install, the binary isn't in PATH. Full path in that layout: `~/.openclaw/projects/ocp/ocp`
|
||||||
|
|
||||||
|
**Single-machine use** — just set your IDE to use the proxy:
|
||||||
|
```bash
|
||||||
|
export OPENAI_BASE_URL=http://127.0.0.1:3456/v1
|
||||||
|
```
|
||||||
|
|
||||||
|
**LAN mode** — reach OCP from your own devices on the network (Claude Pro/Max are per-user accounts — see [Sharing with family / a team — honest limits](#deployment-model--security-read-this) before extending access to other people):
|
||||||
|
```bash
|
||||||
|
# Enable LAN access with per-user auth (recommended)
|
||||||
|
node setup.mjs --bind 0.0.0.0 --auth-mode multi
|
||||||
|
```
|
||||||
|
|
||||||
|
Then create API keys for each person/device:
|
||||||
|
```bash
|
||||||
|
# Generate a strong admin key (one-time — save it for later key management):
|
||||||
|
export OCP_ADMIN_KEY=$(openssl rand -base64 32)
|
||||||
|
# Add the same export line to ~/.zshrc or ~/.bashrc so it persists.
|
||||||
|
|
||||||
|
ocp keys add wife-laptop
|
||||||
|
# ✓ Key created for "wife-laptop"
|
||||||
|
# API Key: ocp_example12345abcde...
|
||||||
|
# Copy this key now — you won't see it again.
|
||||||
|
|
||||||
|
ocp keys add son-ipad
|
||||||
|
ocp keys add pi-server
|
||||||
|
```
|
||||||
|
|
||||||
|
Run `ocp lan` to see your IP and ready-to-share instructions.
|
||||||
|
|
||||||
|
**Verify:**
|
||||||
|
```bash
|
||||||
|
curl http://127.0.0.1:3456/v1/models
|
||||||
|
# Returns: claude-opus-4-8, claude-opus-4-7, claude-opus-4-6, claude-sonnet-5, claude-sonnet-4-6, claude-haiku-4-5-20251001
|
||||||
|
```
|
||||||
|
|
||||||
|
### Headless install notes
|
||||||
|
|
||||||
|
OCP is designed for always-on devices that often don't have a desktop browser — Mac mini, NAS, Raspberry Pi, cloud VPS. The Claude CLI auth flow still works headless:
|
||||||
|
|
||||||
|
**Option 1 — interactive OAuth over SSH (one-shot).** `claude auth login` prints a URL + 8-digit code. Open the URL on **any** device with a browser (your laptop, phone), sign in to your Anthropic account, and paste the code back into the SSH session. No browser needed on the server itself.
|
||||||
|
|
||||||
|
**Option 2 — long-lived token (auth once, no re-prompts).**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
claude setup-token # subscription-backed long-lived token
|
||||||
|
```
|
||||||
|
|
||||||
|
Same Claude subscription as Option 1; the token is stored in Claude CLI's normal config location. Useful when you'd rather not redo the OAuth flow when sessions expire.
|
||||||
|
|
||||||
|
If `claude auth login` errors out with something like `cannot open browser`, you've hit the same case — fall back to either option above.
|
||||||
|
|
||||||
|
## AI-assisted install prompts
|
||||||
|
|
||||||
|
If you've got Claude Code, Cursor, or any other AI coding assistant on this machine, you can copy-paste one of these prompts and let the AI walk through the install for you. Each prompt pins the AI to the right README section, names the verification step, and forbids silent retries — so you stay in the loop.
|
||||||
|
|
||||||
|
**Single-machine use** — install OCP for IDEs on this same machine only:
|
||||||
|
|
||||||
|
```text
|
||||||
|
I want to install OCP on this machine to use my Claude Pro/Max subscription
|
||||||
|
as an OpenAI-compatible API for local IDEs.
|
||||||
|
|
||||||
|
Please follow https://github.com/dtzp555-max/ocp/blob/main/README.md
|
||||||
|
§Quickstart (single-machine install):
|
||||||
|
|
||||||
|
1. Verify prerequisites: macOS or Linux, Node.js 22.5+, git, Claude CLI
|
||||||
|
installed and logged in (`claude auth status`). Install missing pieces
|
||||||
|
using my system's package manager.
|
||||||
|
2. git clone the repo, cd in, and run `node setup.mjs`.
|
||||||
|
3. Verify with `curl http://127.0.0.1:3456/v1/models` (should list 6 models).
|
||||||
|
4. Add `export OPENAI_BASE_URL=http://127.0.0.1:3456/v1` to my shell rc.
|
||||||
|
5. Tell me to reload my shell and try a tool like Cline / Continue / Cursor.
|
||||||
|
|
||||||
|
Before each step, tell me what you'll run and wait for confirmation.
|
||||||
|
On any error, diagnose first — don't auto-retry.
|
||||||
|
```
|
||||||
|
|
||||||
|
**LAN mode (server)** — install OCP as a server so your own devices on the LAN can reach it (Claude Pro/Max are per-user accounts — review Anthropic's Usage Policy before extending access to other people):
|
||||||
|
|
||||||
|
```text
|
||||||
|
I want to install OCP on this device as a LAN server so my own devices on the
|
||||||
|
network can reach my Claude Pro/Max subscription through a local
|
||||||
|
OpenAI-compatible endpoint.
|
||||||
|
|
||||||
|
Please follow https://github.com/dtzp555-max/ocp/blob/main/docs/lan-mode.md
|
||||||
|
"Server Setup" → "LAN mode" path:
|
||||||
|
|
||||||
|
1. Verify prerequisites: macOS or Linux (Windows not supported), Node.js
|
||||||
|
22.5+, git, Claude CLI installed and authenticated.
|
||||||
|
2. Generate a strong admin key with `openssl rand -base64 32`. Save it —
|
||||||
|
I'll need it to manage per-user keys later.
|
||||||
|
3. git clone https://github.com/dtzp555-max/ocp.git && cd ocp
|
||||||
|
4. Run `node setup.mjs --bind 0.0.0.0 --auth-mode multi`.
|
||||||
|
5. Add OCP_ADMIN_KEY to my shell rc (~/.zshrc or ~/.bashrc).
|
||||||
|
6. Run `ocp lan` to show me the LAN IP and connect command.
|
||||||
|
7. Optionally create example keys: `ocp keys add laptop`, `ocp keys add tablet`.
|
||||||
|
8. Verify: `curl http://127.0.0.1:3456/v1/models` returns 6 models.
|
||||||
|
|
||||||
|
Tell me each step before running it. On error, diagnose before retrying.
|
||||||
|
```
|
||||||
|
|
||||||
|
**Client connect** — configure this device to use an existing OCP server on your LAN:
|
||||||
|
|
||||||
|
```text
|
||||||
|
There's an OCP server at <SERVER_IP> on my LAN. Configure this machine to
|
||||||
|
use it for any local IDEs (Cursor, Cline, Continue.dev, OpenCode, OpenClaw).
|
||||||
|
|
||||||
|
Server IP: <SERVER_IP>
|
||||||
|
API key (leave blank if the server has anonymous mode enabled): <OPTIONAL_KEY>
|
||||||
|
|
||||||
|
Please follow https://github.com/dtzp555-max/ocp/blob/main/docs/lan-mode.md
|
||||||
|
"Client Setup" path:
|
||||||
|
|
||||||
|
1. Download ocp-connect:
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/dtzp555-max/ocp/main/ocp-connect -o ocp-connect
|
||||||
|
chmod +x ocp-connect
|
||||||
|
2. Run `./ocp-connect <SERVER_IP>` (add `--key <KEY>` if you have one).
|
||||||
|
3. Follow any IDE-specific manual hints it prints.
|
||||||
|
4. Verify: `curl http://<SERVER_IP>:3456/v1/models` returns 6 models.
|
||||||
|
5. Tell me to reload my shell + restart any IDE that was already running.
|
||||||
|
|
||||||
|
Don't auto-retry on error. Tell me the failure mode first.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Client Setup
|
||||||
|
|
||||||
|
> Clients do **not** need to install Node.js, Claude CLI, or the OCP repo. Only `curl` and `python3` are required (pre-installed on most Linux/Mac systems).
|
||||||
|
>
|
||||||
|
> **Find the server's LAN IP** by running `ocp lan` on the server machine — it prints both the IP and a ready-to-share connect command.
|
||||||
|
|
||||||
|
**One-command setup** — download the lightweight `ocp-connect` script:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/dtzp555-max/ocp/main/ocp-connect -o ocp-connect
|
||||||
|
chmod +x ocp-connect
|
||||||
|
./ocp-connect <server-ip>
|
||||||
|
```
|
||||||
|
|
||||||
|
**Zero-config** — when the server admin has set `PROXY_ANONYMOUS_KEY` *and* opted in with `PROXY_ADVERTISE_ANON_KEY=1` (see [Anonymous Access](#anonymous-access-optional) below), just pass the server IP and nothing else. `ocp-connect` reads the anonymous key from `/health` and uses it automatically. Without the opt-in, `/health` does not expose the key (issue #109); pass `--key` or rely on anonymous access instead:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./ocp-connect <server-ip>
|
||||||
|
```
|
||||||
|
|
||||||
|
If the server requires a key, pass it with `--key`:
|
||||||
|
```bash
|
||||||
|
./ocp-connect <server-ip> --key <your-api-key>
|
||||||
|
```
|
||||||
|
|
||||||
|
Or as a one-liner (no file saved):
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/dtzp555-max/ocp/main/ocp-connect | bash -s -- <server-ip>
|
||||||
|
```
|
||||||
|
|
||||||
|
Example:
|
||||||
|
```
|
||||||
|
$ ./ocp-connect 192.168.1.100
|
||||||
|
|
||||||
|
OCP Connect v1.3.0
|
||||||
|
─────────────────────────────────────
|
||||||
|
Remote: http://192.168.1.100:3456
|
||||||
|
|
||||||
|
Checking connectivity...
|
||||||
|
✓ Connected
|
||||||
|
|
||||||
|
Remote OCP v3.11.0 (auth: multi)
|
||||||
|
|
||||||
|
ⓘ Using server-advertised anonymous key: ocp_publ...n_v1
|
||||||
|
(set by admin via PROXY_ANONYMOUS_KEY; see issue #12 §14 Path A)
|
||||||
|
|
||||||
|
Testing API access...
|
||||||
|
✓ API accessible (6 models available)
|
||||||
|
|
||||||
|
Shell config:
|
||||||
|
✓ .bashrc
|
||||||
|
✓ .zshrc
|
||||||
|
OPENAI_BASE_URL=http://192.168.1.100:3456/v1
|
||||||
|
|
||||||
|
System-level (launchctl):
|
||||||
|
✓ OPENAI_BASE_URL set for GUI apps and daemons
|
||||||
|
|
||||||
|
IDE Configuration
|
||||||
|
─────────────────────────────────────
|
||||||
|
Detected: OpenClaw (~/.openclaw/openclaw.json)
|
||||||
|
|
||||||
|
Configure OpenClaw to use this OCP? [Y/n] y
|
||||||
|
Provider name (models show as <name>/model-id) [ocp]: ocp
|
||||||
|
|
||||||
|
How should OCP models be configured?
|
||||||
|
1) Primary — use OCP by default, keep existing models as backup
|
||||||
|
2) Backup — keep current primary, add OCP as additional option
|
||||||
|
|
||||||
|
Choice [1]: 1
|
||||||
|
|
||||||
|
Writing OpenClaw config...
|
||||||
|
✓ Per-agent auth profile seeded (2):
|
||||||
|
• ~/.openclaw/agents/main/agent/auth-profiles.json
|
||||||
|
• ~/.openclaw/agents/macbook_bot/agent/auth-profiles.json
|
||||||
|
✓ OpenClaw configured
|
||||||
|
Provider: ocp
|
||||||
|
Models:
|
||||||
|
• ocp/claude-opus-4-8
|
||||||
|
• ocp/claude-opus-4-7
|
||||||
|
• ocp/claude-opus-4-6
|
||||||
|
• ocp/claude-sonnet-5
|
||||||
|
• ocp/claude-sonnet-4-6
|
||||||
|
• ocp/claude-haiku-4-5-20251001
|
||||||
|
Priority: PRIMARY (default model)
|
||||||
|
|
||||||
|
Restart OpenClaw to apply: openclaw gateway restart
|
||||||
|
|
||||||
|
Running smoke test...
|
||||||
|
✓ Smoke test passed: OK
|
||||||
|
Note: smoke test only verifies OCP is reachable and the key is valid.
|
||||||
|
It does not verify your IDE/agent end-to-end. To verify OpenClaw works,
|
||||||
|
restart it (`openclaw gateway restart`) and send a test message to your bot.
|
||||||
|
|
||||||
|
Done. Reload your shell to apply:
|
||||||
|
source ~/.zshrc
|
||||||
|
```
|
||||||
|
|
||||||
|
The script automatically:
|
||||||
|
- Writes env vars to all relevant shell rc files (`.bashrc`, `.zshrc`)
|
||||||
|
- Sets system-level env vars (`launchctl setenv` on macOS, `environment.d` on Linux)
|
||||||
|
- **Auto-discovers anonymous key** from `/health.anonymousKey` when no `--key` given (v1.3.0+, requires server v3.10.0+; server must also set `PROXY_ADVERTISE_ANON_KEY=1` — see [Anonymous Access](#anonymous-access-optional))
|
||||||
|
- Configures OpenClaw automatically (including per-agent `auth-profiles.json` for multi-agent setups)
|
||||||
|
- Detects Cline, Continue.dev, Cursor, and opencode, and prints setup hints (manual configuration required for these IDEs)
|
||||||
|
|
||||||
|
On macOS, `launchctl setenv` vars reset on reboot — re-run `ocp-connect` after restart.
|
||||||
|
|
||||||
|
**Manual setup** — if you prefer not to use the script:
|
||||||
|
```bash
|
||||||
|
export OPENAI_BASE_URL=http://<server-ip>:3456/v1
|
||||||
|
export OPENAI_API_KEY=ocp_<your-key>
|
||||||
|
```
|
||||||
|
Add these lines to `~/.bashrc` or `~/.zshrc` to persist across sessions.
|
||||||
|
|
||||||
|
## Monitoring (Server-side)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Per-key usage stats
|
||||||
|
ocp usage --by-key
|
||||||
|
# Key Reqs OK Err Avg Time
|
||||||
|
# wife-laptop 5 5 0 8.0s
|
||||||
|
# son-ipad 3 3 0 6.2s
|
||||||
|
|
||||||
|
# Manage keys
|
||||||
|
ocp keys # List all keys
|
||||||
|
ocp keys revoke son-ipad # Revoke a key
|
||||||
|
```
|
||||||
|
|
||||||
|
**Web Dashboard:** Open `http://<server-ip>:3456/dashboard` in any browser for real-time monitoring — per-key usage, request history, plan utilization, and system health.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Auth Modes
|
||||||
|
|
||||||
|
| Mode | Env | Use Case |
|
||||||
|
|------|-----|----------|
|
||||||
|
| `none` | `CLAUDE_AUTH_MODE=none` | Trusted home network, no auth needed |
|
||||||
|
| `shared` | `CLAUDE_AUTH_MODE=shared` + `PROXY_API_KEY=xxx` | Everyone shares one key |
|
||||||
|
| `multi` | `CLAUDE_AUTH_MODE=multi` + `OCP_ADMIN_KEY=xxx` | Per-person keys for usage tracking + quotas (trusted users only — see Deployment model below) |
|
||||||
|
|
||||||
|
> **Usage scope (v3.14.0+):** `/api/usage` returns the caller's own rows by default. Admin callers must pass `?all=true` to retrieve data for all keys; doing so emits an audit log line.
|
||||||
|
|
||||||
|
## Deployment model & security (read this)
|
||||||
|
|
||||||
|
**What OCP is built for today: single-user, multi-IDE.** Run OCP as a server on one machine and point all of *your own* IDEs/devices at it — one Claude Pro/Max subscription, used everywhere. This is the primary, solid use case.
|
||||||
|
|
||||||
|
**Sharing with family / a team — honest limits.** You *can* share OCP on a LAN, but be clear about what the auth modes do and don't give you:
|
||||||
|
|
||||||
|
- The per-key modes (`shared` / `multi`) give per-key **usage tracking, quotas, and cache separation** — useful for seeing who used what and capping budgets.
|
||||||
|
- They do **not** give a **security isolation boundary**. The spawned `claude` runs with the **operator's filesystem access** and is *not* sandboxed per key. **Only share with people you fully trust, on a trusted network.**
|
||||||
|
- For simple trusted family sharing, the easiest setup is a single shared **anonymous key** (see [Anonymous Access](#anonymous-access-optional)) — no per-person separation, same trust assumption.
|
||||||
|
- **Account terms and ToS — read before sharing with others.** Claude Pro/Max are *per-user* accounts. Pooling a single subscription across **multiple distinct people** may violate Anthropic's Consumer Terms of Service and risk account suspension by the abuse classifier. The defensible framing is **"one person, your own devices"** — sharing with friends or a team is not. OCP does not change your account terms, and whether any particular sharing setup complies with the ToS is the account holder's responsibility. Review Anthropic's Usage Policy before extending access to other people.
|
||||||
|
|
||||||
|
**Real per-user isolation (sandboxed, multi-tenant-safe) is planned for after 2026-06-15** — per-key ephemeral home + tool lockdown + an OS sandbox. Until then, treat a multi-user OCP as a *trusted-group convenience*, not a security boundary. (This is also why `CLAUDE_TUI_MODE` is single-user-only — see [Subscription-pool (TUI) mode](tui-mode.md#subscription-pool-tui-mode).)
|
||||||
|
|
||||||
|
## Anonymous Access (optional)
|
||||||
|
|
||||||
|
In `multi` mode, the admin can designate a single well-known "anonymous" key that bypasses `validateKey()` and grants public read/write access. This is useful for letting LAN users (or clients like OpenClaw multi-agent setups) connect without individual per-user keys.
|
||||||
|
|
||||||
|
**Enable**:
|
||||||
|
|
||||||
|
The anonymous key is wired into the service unit (launchd plist on macOS, systemd unit on Linux) at install time. Export `PROXY_ANONYMOUS_KEY` in your shell before running `setup.mjs`, and `setup.mjs` will write it into the service unit env so the auto-started proxy picks it up:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export PROXY_ANONYMOUS_KEY=ocp_public_anon # or any string of your choice
|
||||||
|
node setup.mjs --bind 0.0.0.0 --auth-mode multi
|
||||||
|
```
|
||||||
|
|
||||||
|
If OCP is already installed without it, re-export the env var and re-run `node setup.mjs` (the installer is idempotent — it refreshes the service unit). Then `ocp restart` so the running proxy picks up the new env. Setting `PROXY_ANONYMOUS_KEY` only in your interactive shell **does not** affect the auto-started proxy — the service unit is the source of truth for its environment.
|
||||||
|
|
||||||
|
**Client side**: the anonymous key value is exposed via `GET /health` as the field `anonymousKey` (null when not set) **only to localhost callers** or when the admin has also set `PROXY_ADVERTISE_ANON_KEY=1` (default off — see issue #109). With that opt-in, clients like `ocp-connect` can auto-discover and use it, so the end user doesn't need to get a personal key from the admin.
|
||||||
|
|
||||||
|
**Security note**: setting this env var is an **opt-in** to public access — anyone who can reach your OCP endpoint can use it, up to any rate limits you configure. Don't enable this on internet-exposed OCP instances without additional protection.
|
||||||
|
|
||||||
|
**Not a secret**: because `/health` is an unauthenticated endpoint, the anonymous key is **publicly readable** by anyone who can reach the server. That is intentional — the key exists so clients can self-configure without out-of-band coordination. Treat it as a convenience handle, not as an access credential.
|
||||||
|
|
||||||
|
## Per-Key Quota (Budget Control)
|
||||||
|
|
||||||
|
Prevent any single user from exhausting your subscription. Set daily, weekly, or monthly request limits per API key:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Set a daily limit of 50 requests for a key
|
||||||
|
curl -X PATCH http://127.0.0.1:3456/api/keys/wife-laptop/quota \
|
||||||
|
-H "Authorization: Bearer $OCP_ADMIN_KEY" \
|
||||||
|
-d '{"daily": 50}'
|
||||||
|
|
||||||
|
# Set multiple limits at once
|
||||||
|
curl -X PATCH http://127.0.0.1:3456/api/keys/son-ipad/quota \
|
||||||
|
-H "Authorization: Bearer $OCP_ADMIN_KEY" \
|
||||||
|
-d '{"daily": 20, "weekly": 100}'
|
||||||
|
|
||||||
|
# Check current quota + usage
|
||||||
|
curl http://127.0.0.1:3456/api/keys/wife-laptop/quota
|
||||||
|
# → { "daily": { "limit": 50, "used": 12 }, "weekly": { "limit": null, "used": 34 }, ... }
|
||||||
|
|
||||||
|
# Remove a limit (set to null)
|
||||||
|
curl -X PATCH http://127.0.0.1:3456/api/keys/wife-laptop/quota \
|
||||||
|
-d '{"daily": null}'
|
||||||
|
```
|
||||||
|
|
||||||
|
When a key exceeds its quota, OCP returns HTTP 429 with a structured error:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"error": {
|
||||||
|
"message": "Quota exceeded: 50/50 requests (daily). Resets 6h 12m.",
|
||||||
|
"type": "quota_exceeded",
|
||||||
|
"quota": { "period": "daily", "limit": 50, "used": 50, "resetsIn": "6h 12m" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `null` = unlimited (default for all keys)
|
||||||
|
- Only successful requests count toward quota
|
||||||
|
- Admin and anonymous users are never subject to quotas
|
||||||
|
- PATCH is a partial update — omitted fields are left unchanged
|
||||||
|
|
||||||
|
> **Note:** quotas are best-effort. Under concurrent bursts a key can exceed its cap by up to the server's max-concurrency (default 8), and cache hits are not counted toward quota. They cap budgets for cooperative family use, not adversarial abuse.
|
||||||
|
|
||||||
|
## Important Notes
|
||||||
|
|
||||||
|
- All users share your Claude Pro/Max **rate limits** (5h session + 7d weekly)
|
||||||
|
- `ocp usage` shows how much quota remains
|
||||||
|
- Keys are stored in `~/.ocp/ocp.db` (SQLite, zero external dependencies)
|
||||||
|
- Admin key is required for key management API endpoints
|
||||||
|
- The dashboard (`/dashboard`) and health check (`/health`) are always public
|
||||||
|
- File modes for `~/.ocp` (0700), `admin-key` + `ocp.db` (0600) are auto-tightened at server startup as of v3.14.0
|
||||||
@@ -8,7 +8,7 @@ The billing classifier reading `cli` is **necessary but NOT sufficient** proof.
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- `CLAUDE_TUI_MODE=true` already set and OCP restarted (see [TUI-mode setup in README](../../README.md#enabling-tui-mode-opt-in))
|
- `CLAUDE_TUI_MODE=true` already set and OCP restarted (see [TUI-mode setup](../tui-mode.md#enabling-tui-mode-opt-in))
|
||||||
- `tmux` installed on the host
|
- `tmux` installed on the host
|
||||||
- No other OCP traffic during the canary (quiesce — see below)
|
- No other OCP traffic during the canary (quiesce — see below)
|
||||||
- Access to your Anthropic account billing page (manual step — see below)
|
- Access to your Anthropic account billing page (manual step — see below)
|
||||||
@@ -148,4 +148,4 @@ Run this after any major `claude` CLI upgrade. The `auto` mode lets the CLI's ow
|
|||||||
|
|
||||||
- [Flip/rollback runbook](./tui-flip-rollback.md) — how to set and unset `CLAUDE_TUI_MODE` on systemd and launchd hosts
|
- [Flip/rollback runbook](./tui-flip-rollback.md) — how to set and unset `CLAUDE_TUI_MODE` on systemd and launchd hosts
|
||||||
- [ADR 0007](../adr/0007-tui-interactive-mode.md) — TUI-mode architecture and governing rules
|
- [ADR 0007](../adr/0007-tui-interactive-mode.md) — TUI-mode architecture and governing rules
|
||||||
- README § [Subscription-pool (TUI) mode](../../README.md#subscription-pool-tui-mode)
|
- [Subscription-pool (TUI) mode](../tui-mode.md#subscription-pool-tui-mode)
|
||||||
|
|||||||
@@ -176,5 +176,5 @@ If you want to continue using OCP without TUI-mode after 2026-06-15, budget for
|
|||||||
|
|
||||||
- [615-canary runbook](./615-canary.md) — how to verify billing pool routing after a flip
|
- [615-canary runbook](./615-canary.md) — how to verify billing pool routing after a flip
|
||||||
- [ADR 0007](../adr/0007-tui-interactive-mode.md) — TUI-mode architecture; Kill-switch section
|
- [ADR 0007](../adr/0007-tui-interactive-mode.md) — TUI-mode architecture; Kill-switch section
|
||||||
- README § [Subscription-pool (TUI) mode](../../README.md#subscription-pool-tui-mode)
|
- [Subscription-pool (TUI) mode](../tui-mode.md#subscription-pool-tui-mode)
|
||||||
- README § [Environment Variables](../../README.md#environment-variables) — `CLAUDE_TUI_MODE`, `OCP_TUI_ALLOW_LAN=1`
|
- README § [Environment Variables](../../README.md#environment-variables) — `CLAUDE_TUI_MODE`, `OCP_TUI_ALLOW_LAN=1`
|
||||||
|
|||||||
@@ -0,0 +1,136 @@
|
|||||||
|
Part of [OCP](../README.md) — full troubleshooting manual. The README keeps a slim version with the most common issues and the one-time bootstrap quirks; everything else lives here.
|
||||||
|
|
||||||
|
# Troubleshooting
|
||||||
|
|
||||||
|
The simplest path: ask your AI.
|
||||||
|
|
||||||
|
Paste this prompt:
|
||||||
|
|
||||||
|
```
|
||||||
|
Run `ocp doctor` and follow its `next_action`. Tell me if you hit
|
||||||
|
anything that needs human input.
|
||||||
|
```
|
||||||
|
|
||||||
|
The doctor produces a JSON `next_action` with `ai_executable[]` (commands
|
||||||
|
the agent runs verbatim) and `human_required[]` (steps that need you,
|
||||||
|
typically just OAuth).
|
||||||
|
|
||||||
|
## Manual debugging
|
||||||
|
|
||||||
|
### Setup fails with "claude: command not found"
|
||||||
|
|
||||||
|
`setup.mjs` requires the Claude CLI to be on `PATH`. Install it via the [official guide](https://docs.anthropic.com/en/docs/claude-cli), confirm with `which claude`, then run `claude auth login` before re-running `node setup.mjs`.
|
||||||
|
|
||||||
|
### Setup fails with "EADDRINUSE: port 3456 already in use"
|
||||||
|
|
||||||
|
Something else is already bound to port 3456 — usually an old OCP instance. Check what:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lsof -nP -iTCP:3456 -sTCP:LISTEN
|
||||||
|
```
|
||||||
|
|
||||||
|
If it's an old OCP process, stop it before re-running setup:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
launchctl bootout gui/$(id -u)/dev.ocp.proxy # macOS launchd
|
||||||
|
systemctl --user stop ocp-proxy # Linux systemd (installed as a --user unit)
|
||||||
|
```
|
||||||
|
|
||||||
|
(There is no `ocp stop` subcommand — the proxy runs as a service, so stopping it goes through the service manager above. `ocp restart` exists for the bounce case.)
|
||||||
|
|
||||||
|
### Setup fails with "node: command not found" or version error
|
||||||
|
|
||||||
|
OCP requires Node.js 22.5+. Install:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
brew install node # macOS
|
||||||
|
# Linux: see https://nodejs.org/en/download for current install commands
|
||||||
|
```
|
||||||
|
|
||||||
|
Confirm with `node --version` (should be ≥ v22.5).
|
||||||
|
|
||||||
|
### Requests fail or agents stuck
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Clear sessions and restart
|
||||||
|
ocp clear
|
||||||
|
ocp restart
|
||||||
|
|
||||||
|
# If using OpenClaw gateway
|
||||||
|
openclaw gateway restart
|
||||||
|
```
|
||||||
|
|
||||||
|
### Env var change (e.g. `CLAUDE_BIND`, `CLAUDE_CODE_OAUTH_TOKEN`) doesn't take effect after restart
|
||||||
|
|
||||||
|
On **macOS**, `ocp restart` does a full `launchctl bootout` + `bootstrap` of the agent, which **re-reads the plist `EnvironmentVariables`** — so an env change you made (in `~/Library/LaunchAgents/dev.ocp.proxy.plist`) actually takes effect:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ocp restart
|
||||||
|
```
|
||||||
|
|
||||||
|
This is deliberate: the older `launchctl kickstart -k` only re-execs the process and **reuses launchd's cached environment**, so plist env edits would be silently ignored. If you ever restart the agent by hand, use bootout+bootstrap, not `kickstart -k`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
launchctl bootout gui/$(id -u)/dev.ocp.proxy 2>/dev/null
|
||||||
|
launchctl bootstrap gui/$(id -u) ~/Library/LaunchAgents/dev.ocp.proxy.plist
|
||||||
|
```
|
||||||
|
|
||||||
|
Verify the new value reached the running process:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ps -E -p "$(launchctl print gui/$(id -u)/dev.ocp.proxy 2>/dev/null | awk '/pid =/{print $3}')" | tr ' ' '\n' | grep CLAUDE_
|
||||||
|
```
|
||||||
|
|
||||||
|
On **Linux**, `systemctl --user restart` already re-reads the unit's `EnvironmentFile`, so no special handling is needed.
|
||||||
|
|
||||||
|
### Usage shows "unknown"
|
||||||
|
|
||||||
|
Usually caused by an expired Claude CLI session. Fix:
|
||||||
|
```bash
|
||||||
|
claude auth login
|
||||||
|
ocp restart
|
||||||
|
```
|
||||||
|
|
||||||
|
### Startup log warns "OpenClaw registry out of sync"
|
||||||
|
|
||||||
|
On boot, OCP compares OpenClaw's registered models against [`models.json`](../models.json) and warns if they drift. Cause: someone (or an OpenClaw upgrade) modified `~/.openclaw/openclaw.json` and removed entries OCP expects. Fix:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node ~/ocp/scripts/sync-openclaw.mjs
|
||||||
|
```
|
||||||
|
|
||||||
|
This is read-only at startup; the warning never blocks the gateway from running.
|
||||||
|
|
||||||
|
### A TUI session vanished right after upgrading OCP
|
||||||
|
|
||||||
|
If you ran a pre-3.21.1 OCP instance and a post-3.21.1 instance on the same host at the same time during an upgrade, the new instance's one-time boot reap can, once, kill an old-format (`ocp-tui-<8hex>`) live TUI session belonging to the still-running old instance — restart the affected session (`ocp restart` or re-run your TUI turn) and it will come back under the new instance's port-scoped naming.
|
||||||
|
|
||||||
|
### OpenClaw shows old models after `ocp update` (v3.10→v3.11 only)
|
||||||
|
|
||||||
|
One-time bootstrap quirk for the v3.10.0 → v3.11.0 jump only — the running shell had the old `cmd_update` cached. Run once manually:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node ~/ocp/scripts/sync-openclaw.mjs
|
||||||
|
openclaw gateway restart # so OpenClaw re-reads the config
|
||||||
|
```
|
||||||
|
|
||||||
|
Future `ocp update` invocations sync automatically.
|
||||||
|
|
||||||
|
<a id="tui-401"></a>
|
||||||
|
### TUI-mode returns a permanent `Please run /login` 401 (re-login doesn't stick)
|
||||||
|
|
||||||
|
A long-running TUI-mode host can get stuck returning a permanent 401 (`Please run /login · API Error: 401`) that re-login cannot fix.
|
||||||
|
|
||||||
|
**Root cause (two layers):** interactive `claude` **prefers `~/.claude/.credentials.json` over the `CLAUDE_CODE_OAUTH_TOKEN` env var** (this is *unlike* the `-p` path, where the env token wins). So (a) a stale/corrupt `credentials.json` **shadows** the env token — passing the token is not enough on its own; and (b) when claude does use `credentials.json`, its single-use OAuth refresh token can be corrupted (ending up an empty string) by the per-request spawn + `kill-session` teardown racing claude's token rotation. Re-login writes a fresh token, but the next spawn re-corrupts it. Proven live on PI231: *env token passed + broken `credentials.json` present → 401; env token passed + `credentials.json` moved aside → works.*
|
||||||
|
|
||||||
|
**Fix:** set `CLAUDE_CODE_OAUTH_TOKEN` on the OCP host and leave `OCP_TUI_HOME` **unset**. OCP then runs the TUI `claude` in a **credential-isolated home** (`$HOME/.ocp-tui/home`) that has **no `credentials.json`** at all, so the env token is the only credential (authoritative — nothing shadows it) and claude never runs the refresh path (so the single-use token can't be corrupted). Then restart — on systemd `daemon-reload`, on launchd `bootout`+`bootstrap`; `kickstart -k` does **not** reload env. Verify the env reached the process and the boot log shows the isolated home:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Linux (systemd): confirm the token is in the service env
|
||||||
|
tr '\0' '\n' < /proc/$(pgrep -f server.mjs | head -1)/environ | grep CLAUDE_CODE_OAUTH_TOKEN
|
||||||
|
# Boot log should read: TUI-mode: ON home=$HOME/.ocp-tui/home ... auth=env-token (credential-isolated home — no credentials.json)
|
||||||
|
```
|
||||||
|
|
||||||
|
> If you previously set `OCP_TUI_HOME` to the real home (or any home that contains a `credentials.json`), **unset it** so the credential-isolated default takes effect — otherwise the shadowing `credentials.json` remains in play.
|
||||||
|
|
||||||
|
See [Subscription-pool (TUI) mode](tui-mode.md#subscription-pool-tui-mode) and ADR 0007 PR-C / PR-D amendments.
|
||||||
@@ -0,0 +1,196 @@
|
|||||||
|
Part of [OCP](../README.md) — subscription-pool (TUI) mode: serve requests through interactive `claude` so they bill the Pro/Max subscription pool instead of the metered Agent SDK path.
|
||||||
|
|
||||||
|
# Subscription-pool (TUI) mode
|
||||||
|
|
||||||
|
> **SECURITY — read before enabling.**
|
||||||
|
> TUI-mode is **single-user / single-operator only**. `claude` runs with the OCP process owner's filesystem access regardless of `HOME` setting. If OCP serves multiple users or guest API keys, a guest prompt could exfiltrate files or exhaust the subscription. **Never enable `CLAUDE_TUI_MODE=true` on a multi-user OCP.**
|
||||||
|
|
||||||
|
## What it is and why
|
||||||
|
|
||||||
|
> **⚠️ Status (as of 2026-07): the billing split below is PAUSED.** Anthropic announced it for 2026-06-15, then paused it on the effective date — *"For now, nothing has changed: Claude Agent SDK, `claude -p`, and third-party app usage still draw from your subscription's usage limits"* ([official help article](https://support.claude.com/en/articles/15036540-use-the-claude-agent-sdk-with-your-claude-plan)). While the pause holds, OCP's default `-p` path bills the subscription and **TUI-mode is a hedge, not a necessity**. The table describes the *announced* regime, kept here because Anthropic says a reworked change will return (with advance notice) — everything in this section is ready to flip on that day.
|
||||||
|
|
||||||
|
The announced routing keys `claude` invocations by `cc_entrypoint`:
|
||||||
|
|
||||||
|
| Launch method | `cc_entrypoint` | Billing pool (announced regime, currently paused) |
|
||||||
|
|---------------|-----------------|-------------|
|
||||||
|
| `claude -p` / `--output-format` (OCP default) | `sdk-cli` | Agent SDK credit pool (~$20/mo on Pro) |
|
||||||
|
| Interactive `claude` (no flags) | `cli` | Pro/Max subscription pool |
|
||||||
|
|
||||||
|
TUI-mode lets OCP serve requests via the interactive path so they bill against the subscription pool under that regime. The response is read from claude's native JSONL session transcript once the turn is complete, then replayed to the caller as a normal OpenAI completion or chunked SSE response.
|
||||||
|
|
||||||
|
<a id="tui-entrypoint"></a>
|
||||||
|
## Billing-classifier labeling (`OCP_TUI_ENTRYPOINT`)
|
||||||
|
|
||||||
|
`OCP_TUI_ENTRYPOINT` (default `cli`) controls how `CLAUDE_CODE_ENTRYPOINT` is set on the spawn
|
||||||
|
environment. The default (`cli`) pins the value deterministically — immune to a stray inherited
|
||||||
|
env var or a future stdout-redirect bug silently flipping it to `sdk-cli`. This label is honest
|
||||||
|
**only** when the spawn is a genuine interactive PTY (tmux pane, no `-p`, stdout not redirected,
|
||||||
|
and `tmux new-session` verified to succeed). If you need to observe the raw TTY-derived value, set
|
||||||
|
`OCP_TUI_ENTRYPOINT=auto`. See ADR 0007 for the full rationale and governing rule.
|
||||||
|
|
||||||
|
## Enabling TUI-mode (opt-in)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Prerequisites
|
||||||
|
mkdir -p ~/.ocp-tui/work # one-time scratch cwd setup
|
||||||
|
# tmux must be installed: brew install tmux / apt install tmux
|
||||||
|
|
||||||
|
# Enable
|
||||||
|
export CLAUDE_TUI_MODE=true
|
||||||
|
# STRONGLY RECOMMENDED on a TUI host — authenticate via the long-lived OAuth token.
|
||||||
|
# With this set (and OCP_TUI_HOME left UNSET), OCP runs the interactive claude in a
|
||||||
|
# credential-isolated home ($HOME/.ocp-tui/home, no credentials.json), so the env token
|
||||||
|
# is the only credential and is authoritative. This both stops a stale credentials.json
|
||||||
|
# from shadowing the token AND ends the refresh-token corruption that caused a permanent
|
||||||
|
# "Please run /login" 401 (no credentials file → claude never runs the refresh path).
|
||||||
|
# See the auth note below + ADR 0007 PR-D.
|
||||||
|
export CLAUDE_CODE_OAUTH_TOKEN=sk-ant-oat01-...
|
||||||
|
# Optionally tune:
|
||||||
|
export CLAUDE_TUI_WALLCLOCK_MS=180000 # 3 min cap for long Opus turns
|
||||||
|
export OCP_TUI_CWD=$HOME/.ocp-tui/work # default; override if needed
|
||||||
|
export OCP_TUI_ENTRYPOINT=cli # default; use 'auto' to observe TTY-derived value
|
||||||
|
# Do NOT set OCP_TUI_HOME for the recommended setup — leaving it unset is what enables
|
||||||
|
# the credential-isolated home. Set it only to opt into the legacy symlinked-creds mode.
|
||||||
|
```
|
||||||
|
|
||||||
|
Then restart OCP. At boot you will see (with the env token set, isolated home auto-selected):
|
||||||
|
|
||||||
|
```
|
||||||
|
⚠️ TUI-mode ON — single-user only; do NOT enable on a multi-user OCP ...
|
||||||
|
TUI-mode: ON home=/home/user/.ocp-tui/home cwd=/home/user/.ocp-tui/work auth=env-token (credential-isolated home — no credentials.json) wallclock=120000ms maxConcurrent=2
|
||||||
|
```
|
||||||
|
|
||||||
|
## What changes / what doesn't
|
||||||
|
|
||||||
|
- **Callers see no API change.** The response is a normal OpenAI completion object or chunked SSE — identical wire format.
|
||||||
|
- **Real streaming is opt-in (`OCP_TUI_STREAM=1`), and off by default.** By default TUI-mode buffers the full response and replays it as chunked SSE — you see a delay, then the complete response. Set `OCP_TUI_STREAM=1` and `stream:true` turns emit real SSE `delta.content` chunks as `claude` renders them, sourced from `claude`'s own `MessageDisplay` hook (byte-faithful raw markdown, on the subscription pool, no `-p`). Two honest caveats: granularity is **block-level** — the hook fires once per rendered block, so a handful of chunks per answer, scaling with length, not token-by-token; and it moves the **first** byte, not the last, so a consumer that must parse a complete reply gains nothing. The transcript stays authoritative: every streamed turn is asserted against it at the end, and a turn whose stream disagrees is **failed rather than served** (watch `tui.streamDivergences` on `/health`). Evidence: [`plans/2026-07-13-tui-latency/streaming-spike.md`](plans/2026-07-13-tui-latency/streaming-spike.md).
|
||||||
|
- **Cache and singleflight work normally.** TUI-mode writes the buffered response to the cache on success; cache-hits skip the interactive turn entirely.
|
||||||
|
- **The host's `CLAUDE.md` / auto-memory is never injected.** OCP is a proxy — the proxied client (OpenClaw / your IDE) owns its own context and memory. TUI-mode always runs `claude` with `CLAUDE_CODE_DISABLE_CLAUDE_MDS` + `CLAUDE_CODE_DISABLE_AUTO_MEMORY`, so a `CLAUDE.md` on the OCP host can never leak into proxied turns (verified live; see #4). Built-in tool schemas + the interactive system prompt remain (the inherent ~20–35K context floor of interactive mode); MCP is hard-disabled.
|
||||||
|
- **Authenticate via `CLAUDE_CODE_OAUTH_TOKEN` in a credential-isolated home (recommended).** tmux does not forward the parent process's env to the pane, so OCP sets the token explicitly on the spawned `claude` when `CLAUDE_CODE_OAUTH_TOKEN` is present. With the env token set and `OCP_TUI_HOME` unset, OCP runs claude in a **credential-isolated home** (`$HOME/.ocp-tui/home`) that has **no `credentials.json`** — so the env token is the only credential and is authoritative, and claude never runs the token-refresh path. This both stops a stale `credentials.json` from shadowing the token and ends the refresh-token corruption behind the permanent `Please run /login · API Error: 401` (full two-layer root cause, live proof, and fix in [Troubleshooting § the permanent TUI-mode 401](troubleshooting.md#tui-401)). Transcripts land under the same isolated home, so the answer-reader is unaffected. Without the env token, claude falls back to the real home's `credentials.json` (byte-for-byte the previous behaviour). (The token is visible in `ps` on the pane command — acceptable for the single-user A-path; the multi-user B-path is refused at boot.) See ADR 0007 PR-C / PR-D amendments.
|
||||||
|
- **Stale tmux sessions are reaped.** The pane's `claude` is a child of the tmux server (not OCP), so OCP cannot reap it directly; `claude` zombies can otherwise accumulate as `<defunct>` over a long-running host. OCP reaps them at boot and on a 15-min idle sweep by issuing `tmux kill-server` — but **only when no foreign tmux session remains** (it never disrupts a co-hosted `olp-tui-*` instance). See ADR 0007 PR-C amendment.
|
||||||
|
- **Default path unchanged.** Unset `CLAUDE_TUI_MODE` and restart → `callClaude` / `callClaudeStreaming` are used again, byte-for-byte identical to today.
|
||||||
|
- **Concurrency is bounded separately.** TUI turns are heavy (per-request cold-boot + long wallclock), so the TUI path has its own limiter — `OCP_TUI_MAX_CONCURRENT` (default `2`), independent of `CLAUDE_MAX_CONCURRENT`. Excess turns queue; a full queue returns a 503. Tune it up only on a host that can run more interactive `claude` sessions at once.
|
||||||
|
- **Optional warm pane pool (`OCP_TUI_POOL_SIZE`, default off).** Pre-boots panes so a request skips the cold boot — measured p50 `10.17s` → `6.00s` (−41%). Pooled panes are **single-use** (one turn, then killed and replaced in the background), each carrying its own fresh `--session-id`, so one session still means one exchange and no earlier-turn text can leak into a later answer. They are named `ocp-tui-<port>-p<hex>` and coexist with the reaper by design: the sweep **drains the pool first**, then reaps (so `kill-server` still flushes `<defunct>` zombies), then the pool refills in the background. Drain→reap→resume is synchronous, so no request can land mid-sweep; a request arriving while the pool is still re-booting simply misses it and cold-boots. A live pooled pane is never reaped — **including one that is still booting**, whose tmux session already exists — while an *orphaned* one (left by a previous process generation) still is.
|
||||||
|
|
||||||
|
## ⚠️ Latency: TUI mode has a ~6-second floor, and it is immovable
|
||||||
|
|
||||||
|
**TUI mode cannot serve real-time or interactive-latency consumers.** This is a hard property of the
|
||||||
|
path, stated plainly so you can rule it out before building on it:
|
||||||
|
|
||||||
|
| | measured |
|
||||||
|
|---|---|
|
||||||
|
| **TTFT floor (first token)** | **≈ 6 s** — immovable |
|
||||||
|
| cold boot → input bar ready | ~1 s (per request; not the bottleneck) |
|
||||||
|
| OCP's own overhead above the CLI | ~4 s (n=1 same-turn decomposition) |
|
||||||
|
| direct Anthropic API, same prompt (for scale) | 0.84–1.64 s |
|
||||||
|
|
||||||
|
The ~6 s floor is the `claude` CLI itself: it always injects the full Claude Code system prompt plus
|
||||||
|
its tool definitions before your prompt, on every turn, no matter what you ask. No flag removes it
|
||||||
|
(`--exclude-dynamic-system-prompt-sections` was measured: **no effect** on the floor). Extended
|
||||||
|
thinking is *not* the cause — `OCP_TUI_EFFORT` already defaults to `low`, which is what cuts a
|
||||||
|
formerly-inherited `xhigh` down to this floor and collapses its variance.
|
||||||
|
|
||||||
|
On top of the floor you pay the model's generation time (a function of output length). Progressive
|
||||||
|
output is not wired up **yet** (see "No real token streaming" above — it is achievable and planned),
|
||||||
|
so today a turn returns as one blob once generation completes. Note that streaming, when it lands,
|
||||||
|
will move the *first* byte earlier — it does **not** shorten the turn, and a consumer that needs the
|
||||||
|
complete answer gains nothing from it.
|
||||||
|
|
||||||
|
**Use TUI mode for**: batch, background, and latency-insensitive work where the subscription pool is
|
||||||
|
the point. **Do not use it for**: anything a person is waiting on interactively, or any consumer with
|
||||||
|
a sub-5-second budget. Full measurements and methodology:
|
||||||
|
[`plans/2026-07-13-tui-latency/`](plans/2026-07-13-tui-latency/).
|
||||||
|
|
||||||
|
## Monitoring drift via `/health`
|
||||||
|
|
||||||
|
`GET /health` includes a `tui` block so you can poll for a silent billing-pool drift (the top risk under the announced split, if it re-lands — a lost TTY flipping `cc_entrypoint` from `cli` to `sdk-cli` would still return answers but land in the metered pool). The block is **always present** (with `enabled:false` when TUI-mode is off):
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
"tui": {
|
||||||
|
"enabled": true, // CLAUDE_TUI_MODE === "true"
|
||||||
|
"entrypointMode": "cli", // OCP_TUI_ENTRYPOINT (cli | auto | off)
|
||||||
|
"lastEntrypoint": "cli", // last cc_entrypoint observed in a transcript, or null
|
||||||
|
"entrypointMismatches": 0, // count of cli-expected-but-got-other turns — ALERT if this climbs
|
||||||
|
"inflight": 1, // TUI turns running right now
|
||||||
|
"queued": 0, // TUI turns waiting for a concurrency slot
|
||||||
|
"maxConcurrent": 2, // OCP_TUI_MAX_CONCURRENT
|
||||||
|
"pool": { // warm pane pool — null when OCP_TUI_POOL_SIZE=0 (the default)
|
||||||
|
"size": 2, // target warm panes (OCP_TUI_POOL_SIZE)
|
||||||
|
"warm": 2, // panes ready right now — each is a LIVE idle claude process
|
||||||
|
"booting": 0, // replacement panes currently pre-booting
|
||||||
|
"model": "claude-sonnet-4-6", // the model being warmed (the most recently requested one)
|
||||||
|
"hits": 12, // requests served by a warm pane
|
||||||
|
"misses": 1, // requests that fell back to the cold boot (the 1st is always one)
|
||||||
|
"boots": 14, // panes successfully pre-booted
|
||||||
|
"bootFailures": 0, // pre-boots that genuinely never reached the input bar — WATCH this
|
||||||
|
"cancelled": 4, // in-flight boots OCP killed on purpose (drain / model switch) — not faults
|
||||||
|
"dropped": 8 // panes discarded unused (drain sweep / expired / unhealthy)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Alert on `entrypointMismatches > 0` (or `lastEntrypoint !== "cli"`): it means a turn drew from the metered Agent SDK pool instead of the subscription. `inflight` / `queued` show how close the TUI path is to its concurrency cap.
|
||||||
|
|
||||||
|
With the pool on, `hits` / `misses` is the hit rate (a steady single-model consumer should sit near 100% after the first request), and `warm` is your standing idle-process cost. A climbing `bootFailures` means panes are not reaching their input bar — the pool then degrades safely to the cold path, but latency reverts to the un-pooled numbers. `cancelled` counts boots OCP killed *on purpose* (a drain, a model switch) and is **not** a fault signal — do not alert on it. A steadily climbing `dropped` is likewise normal: the 15-min reap sweep drains and re-boots the pool on every tick so `kill-server` can still flush `<defunct>` zombies.
|
||||||
|
|
||||||
|
## Kill-switch
|
||||||
|
|
||||||
|
```bash
|
||||||
|
unset CLAUDE_TUI_MODE
|
||||||
|
# restart OCP
|
||||||
|
```
|
||||||
|
|
||||||
|
The stream-json path is restored immediately. No other change is needed.
|
||||||
|
|
||||||
|
## Operator checklist for the (paused) billing split
|
||||||
|
|
||||||
|
> **Status:** the 2026-06-15 split never took effect — Anthropic paused it on the effective date (see the status note at the top of this section). **Nothing needs flipping while the pause holds.** The checklist is retained verbatim as the runbook for if/when a reworked change lands (Anthropic has promised advance notice).
|
||||||
|
|
||||||
|
Under the announced regime, every host serving traffic must be flipped to TUI-mode **and** canary-verified before the effective date, or it will bill the metered Agent SDK credit pool instead of the subscription.
|
||||||
|
|
||||||
|
- **[Flip/rollback runbook](runbooks/tui-flip-rollback.md)** — how to set `CLAUDE_TUI_MODE=true` on systemd (Linux) and launchd (macOS) hosts. Covers the `daemon-reload` requirement (systemd) and the `bootout`+`bootstrap` cycle requirement (launchd — `launchctl kickstart -k` does not reload plist env).
|
||||||
|
- **[615-canary runbook](runbooks/615-canary.md)** — after each flip, run one quiesced request and compare the Agent SDK credit balance before and after. `entrypoint:cli` in the transcript (the `cc_entrypoint` billing classifier) is necessary but not sufficient — only a stable credit balance confirms the subscription pool is being used. Balance check is a manual step (no known programmatic API for the Agent SDK credit pool balance).
|
||||||
|
|
||||||
|
## Architecture and design decisions
|
||||||
|
|
||||||
|
See [`adr/0007-tui-interactive-mode.md`](adr/0007-tui-interactive-mode.md) for the full rationale, home-strategy options, MCP-disable mechanism, coexistence rules, and the B-path (multi-tenant isolation) roadmap.
|
||||||
|
|
||||||
|
## TUI-mode environment variables
|
||||||
|
|
||||||
|
The README [Environment Variables](../README.md#environment-variables) table lists these as one-line pointers; the full behaviour of each lives here.
|
||||||
|
|
||||||
|
<a id="ocp-tui-stream"></a>
|
||||||
|
### `OCP_TUI_STREAM` — real SSE streaming (opt-in)
|
||||||
|
|
||||||
|
`OCP_TUI_STREAM` default `0` (off). When `=1`, `stream:true` requests emit **real SSE `delta.content` chunks as `claude` generates them**, instead of buffering the turn and replaying it. Deltas come from `claude`'s own `MessageDisplay` hook (registered with `--settings` on the ordinary interactive spawn — banner-verified to stay on the subscription pool, `· Claude Max`). Granularity is **block-level**, not token-level. The transcript remains authoritative: the streamed text is asserted equal to it at end-of-turn, the auth-banner and truncation gates still run before anything is committed, and only the transcript text is cached. A turn whose stream cannot be reconciled with the transcript is **refused** (SSE error frame, not cached) and counted as `tui.streamDivergences` on `/health`. A total hook failure (e.g. `--settings` stops registering it after a `claude` version bump) is a *different, silent* failure mode — every streamed turn still succeeds, fully buffered, with no divergence and no error — so it is counted separately as `tui.streamZeroDeltaTurns` (streamed turns where the hook fired **zero** times) and logged as `tui_stream_zero_deltas`; watch it alongside `streamDivergences`. Default off — the buffered path is unchanged and remains the stable default. ⚠️ **Tool-using turns:** the transcript keeps only the model's **last** assistant message, so if the model narrates before calling a tool ("I'll check that file…") and that narration exceeds `OCP_TUI_STREAM_HOLDBACK`, it has already been streamed and cannot be retracted — the turn is then **refused** rather than served (measured live: Opus narrated 475 chars before a `Bash` call). If your deployment lets the model use tools (the TUI default, and anything with `OCP_TUI_FULL_TOOLS=1`), either raise `OCP_TUI_STREAM_HOLDBACK` above the typical narration length — the narration then stays held back and is correctly discarded, at the cost of a later first chunk — or leave streaming off. Streaming is best suited to tool-light chat proxying. See ADR 0007 (2026-07-13 amendment).
|
||||||
|
|
||||||
|
Two related streaming knobs:
|
||||||
|
|
||||||
|
- **`OCP_TUI_STREAM_DIR`** (default `$HOME/.ocp-tui/stream`) — directory holding the static `MessageDisplay` hook script + settings file, and the per-session delta sink (`<session-id>.jsonl`, removed at turn teardown). One sink **per session-id** — this is what keeps concurrent TUI turns (`OCP_TUI_MAX_CONCURRENT` ≥ 2) from interleaving one client's deltas into another's stream.
|
||||||
|
- **`OCP_TUI_STREAM_POLL_MS`** (default `100`) — interval at which OCP drains the delta sink. The hook fires at block granularity (seconds apart), so a finer poll buys nothing.
|
||||||
|
|
||||||
|
<a id="ocp-tui-stream-holdback"></a>
|
||||||
|
### `OCP_TUI_STREAM_HOLDBACK`
|
||||||
|
|
||||||
|
`OCP_TUI_STREAM_HOLDBACK` default `100`. (TUI-mode, streaming) Characters withheld before the first chunk reaches the client. Two jobs. (1) It keeps the **auth-banner gate** alive under streaming, via a guarantee with two required halves: (i) nothing is emitted for a message until its trimmed accumulation exceeds 100 chars — past the default banner detector's reach, since real banners are ≤100 chars — and (ii) once a message boundary follows an emit, nothing further is ever emitted for the rest of the turn, and the turn is refused outright. Half (i) alone only covers a turn's first message; half (ii) is what covers an error banner rendered as a *later* message (e.g. after tool-using prose). Raise the holdback if you replace the detector via `CLAUDE_TUI_ERROR_PATTERNS` with patterns that can match longer messages — that only affects half (i); OCP warns at boot if you do. (2) It is the knob for **tool-using turns** — see the `OCP_TUI_STREAM` caveat above. Answers shorter than the holdback are simply delivered whole at end-of-turn, exactly as the buffered path does.
|
||||||
|
|
||||||
|
<a id="ocp-tui-pool-size"></a>
|
||||||
|
### `OCP_TUI_POOL_SIZE` — warm pane pool
|
||||||
|
|
||||||
|
`OCP_TUI_POOL_SIZE` default `0` (off). Number of **pre-booted warm `claude` panes** kept ready, so a request does not pay the cold boot. `0` disables the pool entirely — the request path is then exactly the cold-boot path. Max `4`; an unparseable value disables it rather than guessing. **Measured on a Mac mini (Sonnet 4.6, `--effort low`): end-to-end p50 `10.17s` (n=6, pool off) → `6.00s` (n=12 warm hits) — −4.2 s / −41%** — the pool recovers both the ~1.2 s boot *and* ~2.9 s of post-input-bar init that a pane which has been idle a moment has already finished. **Cost:** each warm pane is a *live idle `claude` process* held whether or not a request ever arrives (peak processes ≈ pool size + `OCP_TUI_MAX_CONCURRENT` + 1 booting replacement) — which is why it is opt-in. Panes are **single-use**: one turn, then killed and replaced in the background. The **first request after start (and after any model switch) is always a cold miss** — the pool warms the most recently requested model, since OCP cannot know which model the next caller wants. See [`plans/2026-07-13-tui-latency/`](plans/2026-07-13-tui-latency/).
|
||||||
|
|
||||||
|
<a id="ocp-tui-full-tools"></a>
|
||||||
|
### `OCP_TUI_FULL_TOOLS` — full tool surface (single-user only)
|
||||||
|
|
||||||
|
`OCP_TUI_FULL_TOOLS` default *(unset)*. (TUI-mode, **single-user only**) When `=1`, grant the interactive session the **same tool surface as the `-p` path** — `--allowedTools` (+ optional `--mcp-config`, read from `CLAUDE_ALLOWED_TOOLS` / `CLAUDE_MCP_CONFIG`) — instead of the default MCP-walled, built-in-tools-only set. Lets a trusted single-operator TUI deployment run a **tool-using / MCP agent** (e.g. an OpenClaw assistant) on the subscription pool. Safe because TUI **refuses to boot under `AUTH_MODE=multi`** (hard exit) — no guest key can ever reach the TUI path, so this gate cannot expose tools to an untrusted caller. (Under `AUTH_MODE=shared` + `OCP_TUI_ALLOW_LAN=1`, anyone holding the single shared key reaches it — that is the existing TUI trust model, unchanged.) Note: `--dangerously-skip-permissions` / `CLAUDE_SKIP_PERMISSIONS` is **not** supported for TUI — claude v2.1.x shows an interactive bypass-acceptance screen in headless tmux that cannot be answered, bricking the pane. Use scratch-home `settings.json` `additionalDirectories` instead. See ADR 0007.
|
||||||
|
|
||||||
|
<a id="tui-other-vars"></a>
|
||||||
|
### Other TUI-mode variables
|
||||||
|
|
||||||
|
- **`OCP_TUI_MAX_CONCURRENT`** (default `2`) — Max concurrent interactive TUI turns. **Independent** of `CLAUDE_MAX_CONCURRENT` (which bounds the `-p`/stream-json path; TUI never uses it). A TUI turn is heavy (per-request cold-boot of tmux+claude + up to `CLAUDE_TUI_WALLCLOCK_MS` wallclock), so the default is low to keep small hosts (e.g. a Pi 4) alive under a burst. Excess turns **queue** (bounded); a full queue yields a 503. See ADR 0007 PR-B amendment.
|
||||||
|
- **`OCP_TUI_ENTRYPOINT`** (default `cli`) — Billing-classifier labeling: `cli` (default) pins `cc_entrypoint=cli` deterministically; `auto` lets claude self-classify via TTY detection; `off` leaves the inherited env untouched. Honest only when the spawn is a genuine interactive PTY — see the "Billing-classifier labeling" section above and ADR 0007.
|
||||||
|
- **`OCP_TUI_EFFORT`** (default `low`) — Effort level passed to the interactive `claude` as an explicit `--effort` flag: `low` (default), `medium`, `high`, `xhigh`, `max`, or `inherit` to omit the flag (the pre-flag behaviour: the pane inherits a HOME-dependent effort — the operator's `~/.claude/settings.json` `effortLevel` in real-home mode, claude's built-in default in env-token scratch mode). Explicit `low` cuts measured TTFT p50 by ~40% and collapses run-to-run variance ~15× versus an inherited `xhigh` (see [`plans/2026-07-13-tui-latency/`](plans/2026-07-13-tui-latency/)); proxied requests rarely benefit from extended thinking. Banner-verified to stay on the subscription pool (`· Claude Max`). An invalid value logs a warning and falls back to `low`.
|
||||||
|
- **`OCP_TUI_HOME`** (default *(auto)*) — `HOME` claude runs under. **When unset, OCP picks it for you:** if `CLAUDE_CODE_OAUTH_TOKEN` is set → a **credential-isolated** scratch home `$HOME/.ocp-tui/home` (no `credentials.json`, env-token auth — **recommended**); if no env token → the operator's real home (legacy shared `credentials.json`). Setting this to an **explicit** path overrides the auto-default. The credential handling at that path still follows the env token: **with** the env token it is credential-free (env-token auth, no `credentials.json` written); **without** the env token (and the path ≠ real home) it uses the legacy symlinked-credentials scratch mode, which carries the credential-fork caveat — see ADR 0007. If you previously set this to the real home (or any home containing a `credentials.json`) and hit a permanent 401, unset it — see [Troubleshooting § the permanent TUI-mode 401](troubleshooting.md#tui-401).
|
||||||
|
- **`CLAUDE_TUI_WALLCLOCK_MS`** (default `120000`) — Maximum time in ms to wait for the native transcript to signal turn completion. Increase for long Opus thinking turns.
|
||||||
|
- **`OCP_TUI_CWD`** (default `$HOME/.ocp-tui/work`) — Scratch working directory where interactive claude sessions run. Transcripts land under `<HOME>/.claude/projects/<encoded-cwd>/`. Created automatically.
|
||||||
|
- **`CLAUDE_CODE_OAUTH_TOKEN`** — the recommended TUI credential; when set (and `OCP_TUI_HOME` unset) it selects the credential-isolated home. Full precedence and the 401 root cause it prevents are in [Troubleshooting § the permanent TUI-mode 401](troubleshooting.md#tui-401).
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
Part of [OCP](../README.md) — the full upgrade manual (`ocp update` paths, manual flags, rollback, and OpenClaw auto-sync). The README keeps a short stub with the one-liner.
|
||||||
|
|
||||||
|
# Upgrading
|
||||||
|
|
||||||
|
The simplest path: ask your AI.
|
||||||
|
|
||||||
|
Paste this prompt:
|
||||||
|
|
||||||
|
```
|
||||||
|
Upgrade my OCP. Run `ocp update` and follow whatever it says.
|
||||||
|
If it tells me to run `claude auth login`, I'll do that.
|
||||||
|
```
|
||||||
|
|
||||||
|
What `ocp update` does:
|
||||||
|
|
||||||
|
- **Patch bump** (e.g. `v3.21.0 → v3.21.1`):
|
||||||
|
light path (git pull + npm install + restart).
|
||||||
|
- **Cross-minor** (e.g. `v3.18 → v3.22`):
|
||||||
|
full path: pre-flight check, snapshot, `setup.mjs` (with plist env-merge),
|
||||||
|
service restart, post-flight `/health` and `/v1/models` verification.
|
||||||
|
- **Old version** (< v3.4.0):
|
||||||
|
fresh-install. Pre-v3.4 lacked admin-key/usage-db, so there is nothing to
|
||||||
|
migrate. Your OAuth token (managed by the Claude Code CLI, not OCP) is
|
||||||
|
preserved; you do not need to re-OAuth unless your token expired
|
||||||
|
separately.
|
||||||
|
|
||||||
|
Snapshots are saved to `~/.ocp/upgrade-snapshot-<ISO-ts>/` and never
|
||||||
|
auto-deleted. Clean old ones with `rm -rf ~/.ocp/upgrade-snapshot-*` once
|
||||||
|
you're confident the upgrade is stable.
|
||||||
|
|
||||||
|
## Manual upgrade — same command, no AI
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ocp update # smart-pick path
|
||||||
|
ocp update --check # show available updates, don't apply
|
||||||
|
ocp update --dry-run # preview plan
|
||||||
|
ocp update --target v3.13.0 # pin a specific version
|
||||||
|
ocp update --rollback --yes # restore most recent snapshot (--yes confirms)
|
||||||
|
ocp update --rollback --list # list snapshots, no mutation
|
||||||
|
ocp update --rollback --dry-run # preview rollback plan
|
||||||
|
```
|
||||||
|
|
||||||
|
## When upgrade fails
|
||||||
|
|
||||||
|
`ocp update` prints a recovery line on failure. To restore from the snapshot:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ocp update --rollback --yes # --yes confirms the destructive restore
|
||||||
|
ocp doctor
|
||||||
|
```
|
||||||
|
|
||||||
|
If `ocp doctor` still reports problems after rollback, open a GitHub issue
|
||||||
|
with the snapshot path and the doctor JSON output (`ocp doctor --json`).
|
||||||
|
|
||||||
|
## OpenClaw Auto-Sync (v3.11.0+)
|
||||||
|
|
||||||
|
Whenever the model list in [`models.json`](../models.json) changes, `ocp update` automatically reconciles your OpenClaw config so the model dropdown stays in sync — no more "I upgraded OCP but my Telegram bot still shows the old models" surprises.
|
||||||
|
|
||||||
|
**What gets synced** (and only this — all other config keys are preserved):
|
||||||
|
- `models.providers."claude-local".models` in `~/.openclaw/openclaw.json`
|
||||||
|
- `agents.defaults.models["claude-local/*"]` aliases
|
||||||
|
|
||||||
|
**Safety**:
|
||||||
|
- Timestamped backup written before every change: `~/.openclaw/openclaw.json.bak.<ms>`
|
||||||
|
- Idempotent — already-in-sync runs are a no-op (no backup, no rewrite)
|
||||||
|
- Non-fatal — sync failure does NOT abort `ocp update`; `/v1/models` still works
|
||||||
|
- Skips silently if OpenClaw is not installed (`~/.openclaw/openclaw.json` missing)
|
||||||
|
|
||||||
|
**Manual trigger** (e.g. after fixing a hand-edited config, or for the one-time v3.10.0→v3.11.0 bootstrap quirk):
|
||||||
|
```bash
|
||||||
|
node ~/ocp/scripts/sync-openclaw.mjs
|
||||||
|
node ~/ocp/scripts/sync-openclaw.mjs --quiet # silent unless changes
|
||||||
|
```
|
||||||
|
|
||||||
|
**Opt-out**: `ocp update` only invokes the sync if `node` and `scripts/sync-openclaw.mjs` are both present. Removing the script disables auto-sync; the rest of `ocp update` still works.
|
||||||
|
|
||||||
|
**One-time bootstrap caveat (v3.10.0 → v3.11.0 only)**: the first `ocp update` to v3.11.0 runs the *old* `cmd_update` already loaded into your shell, so the new sync hook does NOT fire on this single jump. Run `node ~/ocp/scripts/sync-openclaw.mjs` once manually. Every future update from v3.11.0+ syncs automatically. (Also captured in the README Troubleshooting section as a bootstrap quirk.)
|
||||||
|
|
||||||
|
**Other IDEs** (Cline / Aider / Cursor / opencode) query `/v1/models` live, so they pick up new models on the next request — no sync needed. Continue.dev users edit their own `config.json` model id manually.
|
||||||
@@ -334,7 +334,7 @@ if (OPENCLAW_PRESENT) {
|
|||||||
`║ Aider / OpenClaw) at: ║`,
|
`║ Aider / OpenClaw) at: ║`,
|
||||||
`║ http://${BIND_ADDRESS}:${String(PORT)}/v1${" ".repeat(Math.max(0, 47 - BIND_ADDRESS.length - String(PORT).length))}║`,
|
`║ http://${BIND_ADDRESS}:${String(PORT)}/v1${" ".repeat(Math.max(0, 47 - BIND_ADDRESS.length - String(PORT).length))}║`,
|
||||||
`║ ║`,
|
`║ ║`,
|
||||||
`║ See README § "Client Setup" for per-IDE instructions. ║`,
|
`║ See docs/lan-mode.md for per-IDE client setup. ║`,
|
||||||
`║ ║`,
|
`║ ║`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user