mirror of
https://github.com/dtzp555-max/olp.git
synced 2026-07-21 21:15:10 +00:00
53afea47ca
Final Phase 4 substantive D-day group. 3 D-days bundled per Iron Rule 11 IDR (plugin consumes existing endpoints; integration docs reference plugin + olp CLI + olp-connect together; README index links all). After this PR merges, Phase 4 has shipped all 5 D-day groups (D60 charter + port / D61-D63 SSE heartbeat+ring+/status / D64-D67 olp CLI+doctor / D68-D70 olp-connect+anonymous-key+ADR0011 / D71-D73 plugin+docs). The v0.4.0 close PR is maintainer-triggered per CLAUDE.md release_kit overlay. ## D71 — olp-plugin/ (OpenClaw gateway plugin) Port OCP ocp-plugin/index.js (311 lines) → OLP olp-plugin/index.js (482 lines) as the /olp Telegram+Discord slash command, but MINUS mutations (no /olp keys keygen, no /olp keys revoke, no /olp restart, no /olp logs — all of these require SSH out of chat for security). Plugin shape: - olp-plugin/index.js — registers /olp command via OpenClaw api.registerCommand - olp-plugin/openclaw.plugin.json — manifest, apiKey REQUIRED, proxyUrl default http://127.0.0.1:4567 (matches D60) - olp-plugin/package.json — minimal: name/version/type:module + OpenClaw discovery block - olp-plugin/README.md — install + configure + use docs; documents the "no mutations from chat" security stance and the dedicated-bot-key pattern (don't share maintainer's personal key with the bot) Subcommand parity with olp CLI (D64-D67): - /olp status → GET /v0/management/status (owner-only) - /olp health → GET /health (public-ok) - /olp usage → GET /v0/management/dashboard-data (owner-only) - /olp models → GET /v1/models (public-ok) - /olp cache → GET /cache/stats (owner-only) - /olp providers → local cross-ref (public-ok) - /olp chain show [<model>] → local (public-ok, advisory if no FS access — defer to ssh + olp chain show) - /olp doctor → informational (HTTP doctor endpoint deferred; advisory to ssh + olp doctor for live use) - /olp help → usage text Port resolution: OLP_PROXY_URL env → OLP_PORT env → plugin config proxyUrl → http://127.0.0.1:4567. Output: Telegram/Discord monospace code block with status icons (🟢🟡🔴). Long responses truncated for the 4096-char message limit. No npm deps. OpenClaw provides Telegram/Discord transport; plugin uses fetch + node builtins only. ## D72 — docs/integrations/*.md (6 IDE pages + index) Per the Phase 4 brainstorm prior-art survey + ADR 0010 § Out-of-scope posture for Claude Code: - continue.md ✅ — config.yaml (NOT config.json); apiBase; requestOptions.headers - cline.md ✅ — "OpenAI Compatible" provider; Cline #7128 base-URL UI bug warning - cursor.md ⚠️ — known base-URL fragility; only enable models OLP serves - aider.md ✅ — OPENAI_API_BASE env + openai/ prefix; .env support - claude-code.md ❌ — explicitly NOT supported per ADR 0010 § /v1/messages defer rationale; recommended alternative: Cline + OLP - openclaw.md ✅ — install olp-plugin via CLI or symlink; configure apiKey; restart gateway Each ~60-120 lines: status / quick setup / known issues / OLP-specific notes / test-it command. docs/integrations/README.md is the index. ## D73 — README cross-references - New § "IDE Setup" links to docs/integrations/README.md - New § "Telegram / Discord Usage" — install + configure + restart + use - Quick Start mentions olp-connect <ip> as family-onboarding command - package.json `files` field extended to include olp-plugin/ so the published tarball ships the plugin ## Test count 672 → 696 (+24 D71-D73 tests in Suite 35: helpers / formatters / dispatch / error paths). All 696 pass locally. ## Scope discipline - server.mjs UNTOUCHED (plugin consumes EXISTING endpoints) - No new npm deps (no Telegram or Discord SDK — OpenClaw provides transport) - No /v1/messages (out of Phase 4 per ADR 0010) - No CHANGELOG / package.json version bump (Phase 4 close handles versioning; only package.json `files` extended for olp-plugin/ publication) ## Implementor flagged for reviewer 1. /olp doctor returns SSH advisory (no HTTP doctor endpoint yet). When future phase exposes /v0/management/doctor, swap advisory branch for real fetchJSON + fmtDoctor (already implemented + tested). 2. /olp providers + chain show have no FS access (plugin runs in OpenClaw gateway process); registry read via lazy-imported models-registry.json from repo root. For live enabled-state visibility users still need /olp status (owner-tier) or ssh + olp providers / olp chain show. 3. No live-server wire test in Suite 35 — existing Suites 31/32 already cover the integration path against the same endpoints; mock-fetch in Suite 35 is sufficient signal for the plugin layer. ## Authority - ADR 0010 § Phase 4 D-day plan D71-D73 line - OCP ocp-plugin/index.js (port reference) - ADR 0010 § Out-of-Phase-4-scope (claude-code.md ❌ rationale) - 2026-05-26 brainstorm (Top OCP inheritance candidates + prior-art survey IDE-specific quirks for cline/cursor/continue docs) Co-authored-by: dtzp555 <dtzp555@gmail.com> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
107 lines
3.7 KiB
Markdown
107 lines
3.7 KiB
Markdown
# Aider + OLP
|
|
|
|
[Aider](https://aider.chat) is a terminal-native pair programmer that
|
|
edits files in your local git repo and commits each change. It speaks
|
|
OpenAI's `/v1/chat/completions` wire format via the `openai/` model
|
|
prefix.
|
|
|
|
**Status:** ✅ Supported.
|
|
|
|
**Tested against:** Aider v0.6x. Aider's OpenAI integration has been stable
|
|
across many releases — this is the most reliable IDE/CLI binding to OLP.
|
|
|
|
## Quick setup
|
|
|
|
Three knobs, all environment variables or `.env`:
|
|
|
|
```bash
|
|
# Required: point Aider at OLP's chat-completions endpoint
|
|
export OPENAI_API_BASE=http://127.0.0.1:4567/v1
|
|
|
|
# Required: OLP plaintext token
|
|
export OPENAI_API_KEY=olp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
|
|
# Then invoke Aider with an OLP-routable model, prefixed `openai/`:
|
|
aider --model openai/claude-sonnet-4-5
|
|
```
|
|
|
|
The `openai/` prefix tells Aider to use its OpenAI-compatible adapter for
|
|
the named model. Aider's litellm layer parses this and sends the request
|
|
to whatever `OPENAI_API_BASE` resolves to.
|
|
|
|
Replace the API key with the plaintext token printed by `olp-keys keygen
|
|
--name=aider`. Family members on the LAN should substitute the OLP host's
|
|
IP for `127.0.0.1` (or use `olp-connect <ip>`).
|
|
|
|
## Aider's `.env` support
|
|
|
|
Aider auto-loads a `.env` file from the current directory or the git repo
|
|
root. The accepted keys are:
|
|
|
|
```bash
|
|
# .env at the project root
|
|
OPENAI_API_BASE=http://127.0.0.1:4567/v1
|
|
OPENAI_API_KEY=olp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
|
|
# Optional: Aider's own AIDER_-prefixed equivalents work too
|
|
AIDER_OPENAI_API_BASE=http://127.0.0.1:4567/v1
|
|
```
|
|
|
|
The `AIDER_` prefix wins over the bare prefix when both are set. Pick one;
|
|
mixing them invites surprises during debugging.
|
|
|
|
**Hygiene:** add `.env` to `.gitignore` if your repo doesn't already. The
|
|
OLP token is plaintext-recoverable from disk only because the chat surface
|
|
explicitly opts into it (see [ADR 0011](../adr/0011-anonymous-key-deployment-context.md))
|
|
— do not let your IDE bind unintentionally.
|
|
|
|
## Known issues
|
|
|
|
- **No custom-headers support.** Aider does not expose a way to set extra
|
|
HTTP headers on outgoing requests. OLP's optional `X-OLP-Chain` /
|
|
`X-OLP-Bypass-Cache` headers are therefore not available via Aider —
|
|
routing is determined by the model name alone.
|
|
|
|
- **`/v1` trailing matters.** `OPENAI_API_BASE` must end at `/v1` (without
|
|
`/chat/completions`); Aider appends the remainder. Setting it to the bare
|
|
host or with a trailing `/chat/completions` causes 404s.
|
|
|
|
- **Aider sends `max_tokens` by default.** OLP forwards `max_tokens` to
|
|
every provider. If you see "model X does not support max_tokens" errors,
|
|
the underlying provider rejects it — check `X-OLP-Provider-Used` and
|
|
filter that provider out of the chain for the affected model.
|
|
|
|
## OLP-specific notes
|
|
|
|
Aider's request shape is faithful to OpenAI's `/v1/chat/completions`
|
|
spec — `messages`, `model`, `max_tokens`, `stream`, `temperature`,
|
|
`tools`. All map cleanly into OLP's IR with no lossy-translation warnings.
|
|
|
|
For long-context work (codebase summaries, large diffs), set
|
|
`streaming.heartbeat_interval_ms: 15000` in `~/.olp/config.json` (see
|
|
[README § Environment Variables](../../README.md#configjson-keys-introduced-at-phase-4))
|
|
so the SSE stream stays alive through reverse proxies during silent
|
|
windows.
|
|
|
|
## Test it
|
|
|
|
```bash
|
|
# In a scratch dir:
|
|
aider --model openai/claude-haiku-4-5 --no-stream --message "say ok"
|
|
```
|
|
|
|
Then check OLP's audit log:
|
|
|
|
```bash
|
|
npx olp logs 5
|
|
```
|
|
|
|
The most recent entry should show `provider: anthropic` (or whatever
|
|
provider haiku routes to in your chain) and `cache_status: miss`.
|
|
|
|
## Cross-references
|
|
|
|
- Aider model config docs: https://aider.chat/docs/llms/openai-compat.html
|
|
- [`olp-connect`](../../bin/olp-connect) writes `~/.aider/.env` if Aider is
|
|
detected on PATH.
|