Imported from funn1est/sub-hub (AGENTS.md). Install upstream with npx skills add funn1est/sub-hub. Copyright stays with the author.

Agent notes

Tracked operating notes for agents in this repository. Public surface, gates, and forbids live in CONTRIBUTING.md. Do not duplicate that document here.

Paths that do not travel with a clone

Root .gitignore is a closed set. Do not modify it unless a maintainer names that change in the same review (CONTRIBUTING.md). Do not git add -f the paths below unless a maintainer asks.

If /docs/ or CONTEXT.md is absent, use CONTRIBUTING.md, the README pair, and SECURITY.md. Origin will not contain the TODO or the glossary.

Where work is authorized

• Public surface and forbids: CONTRIBUTING.md.
• Public README pair: README.md (English, GitHub default) and README.zh-CN.md (Chinese). They are one document in two languages. Changing either — HTTP surface, Run, Native/Worker/Console, env vars, forbids, fixtures, or the language switcher — update both in the same change. Keep sections, commands, and examples aligned. Product terms stay English in the Chinese file (see CONTEXT.md when present). Do not let one side drift. CONTRIBUTING.md and SECURITY.md stay English-only unless a maintainer asks for a Chinese pair.
• Product intro (apps/docs): product copy for the current public surface. It is not repository-root /docs/ and not the Web Console. When the README pair changes HTTP surface, Run, Native/Worker/Console, env vars, or forbids, update apps/docs copy in the same change. Product terms stay English in zh-cn. Do not put a published site URL in the README pair.
• If /docs/ is present: operator / packaging guide is docs/guide.md; living main description is the files listed in docs/README.md; implementation tracker is docs/TODO.md (empty Now is a valid state); docs/research/ is dated evidence, not a backlog — do not implement from it. Do not start Parked items unless a maintainer asks. Do not start Blocked items without the missing prerequisite. Do not implement Won't-do.

Secrets and fixtures

Treat the working tree, tests, docs, commit messages, and agent replies as if a stranger will read them.

Environment and secrets (never write the values):

• .env, crates/sub-hub-worker/.dev.vars, password-manager token lists, Cloudflare Dashboard secrets, account_id, API tokens.
• Binding names are public (SUB_HUB_ACCESS_TOKEN, SUB_HUB_BIND, SUB_HUB_SELF_HOSTS, SUB_HUB_CORS_ORIGINS, SUB_HUB_CONSOLE_ROOT). Their values are not. Do not echo env, Get-Content .env, or wrangler secret output into a commit, a test, docs/, or chat.
• Tests use fixtures such as deployer-token, alpha, bravo — not a live token. Do not add .dev.vars.example or package.json cloudflare.bindings; those collect a value that never becomes a Runtime secret.
• Debug implementations already redact tokens, URLs, and bodies. Do not add dbg! / console.log of request URLs, url= query strings, or node credentials.

Operator-shaped hosts (do not reintroduce):

Keep https://github.com/funn1est/sub-hub — that is the Deploy-to-Cloudflare button URL, not a fixture. Do not rewrite funn1est as a blanket string (would smash that URL).

Ignore / add:

• Do not git add .env or .dev.vars.
• Do not git add -f new testdata/ files unless a maintainer asks. Root .gitignore keeps testdata/ ignored; the two goldens on origin are the only tracked exceptions.
• Do not print ignored file contents in review notes.