pastilhas
2952901c85
opencode discovers AGENTS.md and nothing else; claude code discovers CLAUDE.md. this repo had neither, so an agent sent to change something here arrived with no guidance at all under either. it deliberately does NOT repeat README.md. that file says what the plugin is, for someone deciding whether to install it. this one answers the other question: i have to change something in here, what will i break. the facts in it are read from the repository rather than recalled — the panel keys from web/panels.ts, the tables from db/schema.ts, the permission keys, the host binaries and the route claims from manifest.ts. presence is the declaration everywhere in this system, so the file says what the platform will actually conclude from these files existing. CLAUDE.md beside it is a pointer, not a copy: two copies drift and the stale one is the one somebody reads.
61 lines
2.7 KiB
Markdown
61 lines
2.7 KiB
Markdown
# AGENTS.md
|
|
|
|
Guidance for a coding agent working on **this plugin's own repository**. `CLAUDE.md` beside it only
|
|
points here — the two harnesses discover different filenames and one set of instructions has to
|
|
reach both.
|
|
|
|
**This is not what the plugin is.** `README.md` answers that, for a person deciding whether to
|
|
install it. This file answers "I have to change something in here — what will I break?"
|
|
|
|
## Where you are
|
|
|
|
A plugin repository, cloned into `~/officer-dev/plugins/proxy-manager`, its own git remote. It is **not**
|
|
part of the platform's repository, and `platform/plugins/proxy-manager` is a different thing — that is
|
|
where this plugin gets INSTALLED, by the installer cloning it from gitea. Never edit there; the
|
|
next install overwrites it.
|
|
|
|
Check the checkout with `bun run plugins:check` from the platform repo.
|
|
|
|
## What it ships
|
|
|
|
- `api/router.ts` — routes, mounted at `/api/proxy-manager`
|
|
- `db/schema.ts` — tables: `proxy_manager_connection`, `proxy_manager_domains`, `proxy_manager_dns_credentials`
|
|
- `web/` — panels and a layout; the platform renders the screen, not this plugin
|
|
- `chat/AGENTS.md` — copied into a chat's working directory as its brief
|
|
- `skills/` — read by every agent session, harness-agnostic
|
|
|
|
Presence is the declaration: the platform decides what this plugin has by what files exist. Adding
|
|
`db/schema.ts` gives it tables; deleting `api/router.ts` removes its routes. There is no field to
|
|
keep in step.
|
|
|
|
## What must not change without knowing why
|
|
|
|
- **Permission key `proxy-manager`** — stored as the subject of every grant. Renaming one is a data change, not a rename.
|
|
- **Panel keys** (`proxy-manager-nav`, `proxy-manager-detail`, `proxy-manager-chat`) — a user's stored layout names them.
|
|
- **Table names** — they hold real rows on installed machines.
|
|
- **`appName`** — the directory name IS the id: route segment, table prefix, sidecar suffix, install key.
|
|
|
|
## Traps that have already cost time
|
|
|
|
- **NPM answers 404 unauthenticated on most routes**, so a 404 here often means "not logged in", not "no such thing".
|
|
- **`meta` is `additionalProperties: false`** — `letsencrypt_email` and `letsencrypt_agree` are REJECTED. The email comes from the NPM account.
|
|
- **`GET /nginx/certificates/dns-providers` answers 403**, even authenticated.
|
|
|
|
## Verifying
|
|
|
|
From the platform repo, which is where the toolchain lives:
|
|
|
|
```bash
|
|
bunx tsgo # a red typecheck is not done
|
|
bun test # 1 known failure: ModelSelector, unrelated
|
|
bun run plugins:check
|
|
bunx prettier --write <the files you touched>
|
|
```
|
|
|
|
Changes here need `pm2 restart officer`.
|
|
|
|
## Related
|
|
|
|
- `README.md` — what it is and what it claims, for someone installing it
|
|
- `skills/` — how an agent USES this, as opposed to changing it
|