AGENTS.md · diff
git:20260926.4280a17 to git:20260926.0f988f2
5 added, 0 removed. Audit A to A.
# Contents
- `crates/` owns the native xcb (Excalibur) Rust kernel, local runtime, Ratatui
frontend, and CLI. Panes are bounded userspace data; executable hooks require
separate trust. Keep local metering separate from opt-in aiCharts publishing.
- `src/` owns provider-neutral routing, account leases, model selection,
scoped tool contracts, the `router.ts` subscription-router entry point
(`createSubscriptionRouter`) that bundles the lease store and qualified task
adapters for embedding hosts, the unqualified Devin ACP task adapter
(`devin-acp.ts`, `devin-client.ts`, `devin-adapter.ts`, `devin-mcp.ts`),
per-account browser-session custody (`browser-session.ts`), and the
provider-neutral managed-account controller (`managed-account.ts`), and
the OS-confinement port every provider launcher plans through
(`os-sandbox.ts`; never add a silent unsandboxed fallback), and the
host-side unix-socket CONNECT egress bridge (`egress-bridge.ts`) that makes
`provider-tcp443-dns` plannable on Linux bwrap without unsharing the child's
network namespace — plus its two consumers: the public `egress-client.ts`
for cooperative runtimes and `sandbox/loopback-forwarder.cjs`, the shipped
in-namespace forwarder that gives stock binaries standard `HTTPS_PROXY`
egress through the socket — plus `judge.ts`, the provider-neutral jev-style
judgment port (`ask(state, questions)` → typed answers) with the System One
backend and the cross-platform local key vault. A judge orders
already-admitted routes, may veto auto-continuation only after every
deterministic safety gate passes, and may veto deterministic Gobstopper
elision without receiving tool-result bodies; it never qualifies or activates
a provider. Keep vaulted System One credentials bound to the canonical
endpoint; custom endpoints require an explicit environment key, and future
backends own separate credential custody.
`src/index.ts` is the package's complete public surface.
- `src/cli/` is the standalone `xcb` terminal surface (`cli.ts` entry,
chat/run/resume/sessions/doctor/auth/judge/migrate commands) built on the same
task runtime; `claude-task-adapter.ts` and `cli/sandbox.ts` own the
seatbelted subscription route it drives. `cli/state.ts` resolves `~/.xcb`
(env `XCB_STATE`) and owns the explicit `migrate` copy from legacy
`~/.agentmixer`; SQLite `agentmixer_*` tables rename lazily at open.
- `test/` contains synthetic boundary and concurrency tests.
- `qualification/` holds the host qualification fixtures and native-tooling
checks; its `contact-workspace.ts` is a vendored synthetic fixture, not a
Textbutler import. `linux-sandbox.ts` is the bwrap kernel-boundary probe,
`linux-egress.ts` is the CONNECT-bridge boundary probe, and
`linux-loopback.ts` is the stock-binary forwarder probe; all are evidence,
not activation. The `Check` workflow's `Linux kernel-boundary probes` job
runs them on `ubuntu-24.04` when the probes or sandbox sources change (or on
`workflow_dispatch`) and uploads the JSON evidence.
- `scripts/` holds the dist build, packed-package smoke check, and the
dependency-free release writers and admission checks.
- `site/` is the informational xcb product page (Next.js, canonical origin
xcb.sh); it has no product-runtime connection. Its blog keeps post bodies
in `site/content/blog/` and titles, sources, and admission records in
`site/app/blog/posts.ts`. The `@hraness/xcb`
TypeScript package and its verified publication datum remain a separate
compatibility surface.
- `.github/workflows/` holds the read-only CI matrix and the tag-gated
immutable release pipeline.
- `README.md`, `MANAGED-CODEX.md`, `CONTRIBUTING.md`, `SECURITY.md`, and
`LICENSE` are the public contract.
- `docs/publishing.md` records the release and repository-protection contract.
# Guidelines
- Use Bun 1.3.14 for the compatibility package and site, and Rust 1.97.1 for
native xcb. The owner selected a full Rust migration; Cargo.lock is the
native dependency lock and bun.lock remains the JavaScript lock. Run
`cargo test --workspace --locked`, `cargo clippy --workspace --all-targets
--locked -- -D warnings`, `cargo fmt --all -- --check`, and `bun run check`.
The site has its own `bun run check` inside `site/`.
- Keep account credentials and provider runtime state outside consumer
workspaces. Resolve authentication through a trusted host adapter.
- Never equate a prompt, cwd, tool list or expired lease with OS isolation or
proof that a process stopped.
- Admit a provider only after the host proves the exact runtime, effective tool
inventory, configuration isolation and read/write confinement. Unqualified
adapters remain disabled.
- Exact-artifact admission has two sources: constants baked into a release and
`qualified-builds.json` at the repository root. The Codex catalog workflow
qualifies npm-published darwin-arm64 builds through
`qualification/codex-inventory.py` and opens an auto-merging catalog pull
request. To qualify a build by hand, run the inventory with
`--expect-version`/`--expect-sha256`, then append the reviewed pair with a
`qualifiedBy` naming the evidence source. Never append a pair whose
inventory failed, and never relax the schema-digest check: a wire-protocol
change ships through an xcb release instead.
- Keep broker inputs closed and bounded; applications own filesystem custody
and messaging authorization.
- Preserve exclusive account custody after uncertain provider failures.
Require independent process-exit evidence before recovery.
- Releases use the `v<version>` tag channel and the single-package release
contract in `docs/publishing.md`. The former scoped `agentmixer-v*` /
`agentrouter-v*` / `xcb-v*` namespaces and the `hraness/textbutler`
repository identity are rejected by the release checks on purpose; do not
reintroduce them.
- Keep the public repository independently buildable. Do not reference
sibling checkouts, private packages, or monorepo paths.
<!-- hraness-public-copy:start -->
- Public copy (websites, READMEs, docs, package and GitHub descriptions, CLI help, `llms.txt`, generated pages) follows `STYLE.md`, synced from hraness/.github. Text a model writes for publication also follows `GENERATION_STYLE.md`.
- The delivery vocabulary in this file (admission, qualification, custody, receipt, bounded, lane, gate, surface, projection) is internal. Translate it into what the reader gets.
- Take one-line product and sibling descriptions from the portfolio registry and versions from the release record. Tests pin facts, not prose.
- Run `bun run check:copy` before handoff when the repository has it.
<!-- hraness-public-copy:end -->
+ <!-- hraness-releases:start -->
+ - GitHub Release pages follow `RELEASES.md` in hraness/.github: the title is the registry product name and the tag, and the body is a summary, `## Changes`, `## Install`, `## Verify`, then the repository's identity record as a trailing HTML comment.
+ - The summary and changes come from the version's section of `CHANGELOG.md` in the tagged commit. Write that section in the version bump pull request. The release workflow copies it, generates Install and Verify from the release record, fails when the section is missing or empty, and never uses GitHub's generated notes.
+ <!-- hraness-releases:end -->
+
<!-- hraness-delivery:start -->
- Treat the user's request to change this repository as standing authorization for routine task-owned commits, pushes, pull requests, merges, releases, deployments, and production verification after the gates applicable to that action pass. Do not ask for duplicate confirmation. Build confidence through relevant automated checks, bounded diagnostics, and independent review, not another human approval. Passing checks does not expand task scope or authority.
- Prefer agentic service provisioning for new infrastructure. Check Vercel Marketplace for a native product that can provision the required resource first; use Stripe Projects as a supported alternative when it better covers the service or the Marketplace route only connects an existing account. Verify the current catalog, account, region, plan, recurring cost and resource capabilities before selecting a route. Prefer supported provider CLIs or APIs over browser-only setup when neither catalog fits, and explain the concrete exception. Reuse existing owner-controlled resources where appropriate; this preference alone does not authorize migrations, duplicate accounts, paid upgrades or wider access. Continue setup already authorized by the task and budget without duplicate confirmation. Keep provider credentials and generated environment files private, complete required interactive authentication, and verify deployment, persistence and recovery separately from successful provisioning.
- Separate artifact admission from live qualification and operational activation. Use applicable automated source, security, package/install, and provenance evidence for artifact admission; live provider qualification is not a universal publication prerequisite. Preserve explicit live acceptance criteria and require relevant live evidence for claims that depend on it. If publication or an artifact's install, upgrade, or default-use path activates risky unqualified behavior, keep that behavior guarded or disabled, or obtain bounded relevant evidence before shipping or activation.
- Use the repository's documented delivery workflow and preserve the identity, target, capacity, migration, and recovery guards applicable to operational activation. Replace an obsolete gate through a reviewed source and policy change with corresponding tests, never an ad hoc skip. Preserve every runtime-enforced approval, access control, branch protection, environment rule, safety policy, and required final gate. Ask for user input only when delivery needs a material product decision, missing credentials or authority, unavoidable interactive authentication, an irreversibly destructive action outside task scope, or resolution of a failure that cannot be handled safely and autonomously.
- Preserve production and user data throughout delivery. Inspect the exact account, environment, deployment, and data target before writes. For data changes, inspect a dry run or equivalent migration plan and validate the recovery path before any effect that could lose or corrupt data. Prefer additive, backward-compatible migrations and bounded batches. Record mutation intent, use idempotency or conditional writes, and reconcile uncertain results before retrying. Verify deployed identity, health, and relevant data invariants after delivery. Routine delivery never authorizes resetting, truncating, dropping, or overwriting user data; stop the unsafe operation if preservation or recovery cannot be established.
- Prefer short-lived repository workload identities such as OIDC trusted publishing, GitHub Apps, and narrowly scoped machine identities. Use unattended stable publication and production promotion when supported by the provider and repository. Establish supported machine authority once and verify it with a non-publishing preflight where available; routine releases should not require recurring interactive authentication or conversational approval. Releases and deployments run without a human in the loop: do not add required reviewers, manual approval environments, or wait timers to release or deployment paths, and remove any you find through a reviewed change. Keep account two-factor authentication, and do not add long-lived personal tokens.
- Main delivery is unattended. Open the pull request and enable auto-merge in the same breath (`gh pr merge --auto --squash <number>`), then move on; the required `Required` check is the reviewer. Until a repository's ruleset requires a check, `--auto` merges immediately, so wait for green checks there before merging. Never request a human reviewer or add required approvals, code owners, required conversation resolution, merge queues, manual-approval environments, or wait timers, and remove any you find with `scripts/apply-delivery-policy.py` from hraness/.github rather than by hand. Required checks run on the pull request head and are not re-required after main moves, so auto-merge never stalls behind another merge; main reruns the same gate after integration, and a red main is fixed forward by the next change. Repositories without CI use direct pushes to main.
- Preserve useful reasoning fan-out, but avoid unnecessary checkout fan-out. Prefer subagents in the current task for bounded research, review, diagnosis, and focused checks when they can safely share one working tree; create a separate task or worktree only for independently deliverable divergent edits, an isolated verification tree, or a different execution environment.
- Give each expensive focused validation command and external wait one owner. The integration owner reviews that evidence and runs the repository-required aggregate or final gate once after convergence. Reuse evidence only for the exact Git tree, command, lockfiles, toolchain, relevant environment, and validity period, and never to skip a required final integration, merge, release, deployment, or production-verification gate.
- On Hraness development machines, use the installed host scheduler for heavyweight top-level commands when available. Keep ordinary work in the compute lane; give authenticated browser/dev-server/Chromium work one `browser-auth` owner and Mac-only validation one `mac-native` owner.
- When a CI or policy gate scans complete Git history, check out the exact governed SHA and fetch only the fully qualified governed refs before scanning. Preserve the complete-history gate and reject unexpected refs instead of importing unrelated concurrent heads.
- At closeout, record applicable branch, PR, check, merge, release, deployment, and production evidence. Archive only conclusively finished tasks, never from silence alone, and reclaim only freshly revalidated clean merged worktrees through the guarded exact-path flow.
<!-- hraness-delivery:end -->
<!-- hraness-articles:start -->
- Essays and blog posts follow the essay addendum in `GENERATION_STYLE.md` and `ARTICLE_COPY.md` in `@hraness/design-kit`. The byline is “Hraness”, every post shows the provenance note naming its recorded reviewer, and no AI-drafted post is credited to a person unless that person rewrites and adopts it.
- Take product names, one-line descriptions, addresses, status labels, and relations from the portfolio facts in `@hraness/design-kit`. Render versions from the release record (`package.json`, a published-release file), never typed by hand.
- Write a “How X uses Y” post only for a registered relation that has a description. Change the relation and its post in the same change. Link between products only along registered relations, and between a technique post and product posts about the same technique.
- Every post has a review record: reader job, non-obvious answer, sources with the date checked, owner, reviewer identity, reviewer type (`ai` or `human`), a score out of 12, and a `reassessOn` date 28 to 56 days after review. The reviewer is independent of the run or person that drafted the post. An AI reviewer is recorded and shown as AI; `humanReview` stays null unless a person reviewed the post.
- A new post starts out of search indexes, sitemaps, and feeds. It becomes indexable only when its review record is complete, scores at least 9 of 12 with no zero score, and the page shows the provenance note.
- When a product is renamed or a relation changes, update the post bodies that mention it in the same change.
<!-- hraness-articles:end -->
# Public copy
Public copy is the site, README, `docs/`, `llms.txt`, `package.json` and GitHub
descriptions, CLI help, and TUI text. Follow `STYLE.md` and `WRITING.md`.
- The canonical one-line description, used as the README and `llms.txt` lead, is
“xcb routes coding tasks across the Claude, Codex, and Devin subscriptions
you already pay for.” The page descriptions, README lead, `llms.txt` lead,
`package.json` description, support value proposition, and CLI `about` use
this sentence or a shortening of it. The portfolio registry line lives in
hraness/jungle; propose changes there.
- Write the product as `xcb` (lowercase, also at the start of a sentence) or
Excalibur. Never write XCB or Xcb in prose; `Xcb` is only the TypeScript
class name. Sibling names follow the registry: Textbutler, AI Charts,
PeopleBlade, Gobstopper, Ghostget, Soulscrape, Wordcell, ALGAL.
- State the release status once per page, from `site/published-release.json`
through `site/app/release-state.tsx`. Put each other limit beside the feature
it limits.
- `xcb --json route` picks the account and model. The TypeScript SDK's
`createSubscriptionRouter` does not: the host names the account and model,
and the router holds that account while the task runs. Do not describe the
SDK as the same router.
- The self-tuning managed harness is in development. The current build does
not run self-modifying routing policies; say so wherever the harness appears.
- Describe a sibling product with its registry line, and claim an integration
only when shipped code supports it.
- Keep `↗` for links that leave xcb.sh. Internal links use `→` or no glyph.
- Tests pin facts (no release yet, supported platforms, tested providers,
commands), not headings or sentences.
Internal terms and what to write on public pages instead:
| Internal term | Public wording |
| --- | --- |
| admitted runtime, provider admission | a supported provider build (xcb has checked its exact executable, tools, configuration isolation, and file access) |
| qualified, qualification | tested and approved for the exact build, account, and model |
| credentialed, connected | signed in |
| eligible, eligible set | able to take the task now: supported build, signed in, idle, not at a known quota limit, with a recently seen model |
| custody, lease, generation-fenced | xcb holds the account so no other task can use it |
| settled, settlement | the provider process has exited and xcb has recorded how the run ended |
| joined | the provider's processes have exited |
| unproven custody, uncertain outcome | xcb could not confirm how the run ended, so it keeps the account held and does not retry |
| receipt, transition receipt | the task's local record, which `xcb tasks verify` replays |
| bounded | name the limit: one turn, a deadline, 256 KiB of returned text |
| closed contract, route contract | the JSON request and result of `xcb --json route` |
| fails closed | refuses and changes nothing |
| routing manifest, promoted | routing rule, kept or adopted |
| credential-free boundary proof | sandbox checks run without signing in |
| authenticated coding acceptance | a coding session confirmed on a signed-in account |
| reference host | xcb's own terminal workspace |
| surface | the page, command, or API, by name |
| Pareto tier | models ranked by relative quality, cost, and latency (define it on first use) |
# Workspace write coordination
- Native and compatibility workspace writers share a private SQLite lock database
per canonical UTF-8 workspace path. The default root is
`~/.local/share/xcb-coordination`; `XCB_COORDINATION_ROOT` is a trusted host
override that must agree across cooperating processes, independently of their
application state roots. Tests use explicit isolated coordination roots.
- The lock database name is the workspace path's lowercase SHA-256 plus
`.sqlite`. Keep DELETE journal mode and hold `BEGIN IMMEDIATE` through revision
checking, publication, and directory sync. Never remove an active coordination
database or treat this filesystem lock as account/process-exit evidence.
- Keep the in-process serialization around coordination database setup and use.
Closing an unrelated descriptor for the same SQLite file can release POSIX
record locks held by that process. New-file publication must remain
no-clobber; cooperating replacements preserve ordinary permission bits.
- Native broker integration tests exercise actual Bun and Node lock owners and
process-exit release. Run them with the repository's Bun and Node toolchains
available on PATH. These guarantees cover cooperating broker writers, not
arbitrary editors or processes that bypass the coordination protocol.
- Compatibility lease recovery requires an independently established host stop
witness bound to the exact lease; an absent argv marker or elapsed TTL is not
sufficient. Legacy leases without such a witness remain held.
<!-- algal-skills:start -->
## ALGAL skills
- Prefer the globally installed `algal-*` skills for bounded git state, diffs, repository survey/search, test and release gates, CI polling, and web fetches instead of repeated raw tool output.
- At session start, if the `algal` skill is unavailable, install the current skill pack for Claude Code, Codex, and Devin for Terminal with `bunx skills add 0thernet/algal-skills --global --agent claude-code codex devin --skill '*' --copy --yes`.
- Confirm installation with `bunx skills list --global`. If Bun or network access is unavailable, continue with repository-native tools instead of blocking delivery.
- Treat ALGAL receipts as execution evidence, not provider attestation, and preserve the repository's normal verification and release gates.
<!-- algal-skills:end -->
## CI
<!-- hraness-ci:start -->
- CI exists to admit a change in minutes, not to perform a ceremony. Every workflow declares `concurrency: { group: <name>-${{ github.ref }}, cancel-in-progress: true }` (release and deploy workflows set `cancel-in-progress: false`), a `timeout-minutes` on every job, and `permissions: contents: read` at the top with job-level widening only where needed.
- One job named `Required` closes every check workflow: `if: always()`, `needs:` every blocking job, and a single step that fails unless each `needs.<job>.result == 'success'`, or `skipped` because the change filter below reported its inputs unchanged. Branch policy requires only `Required` (plus a provider's own automated admission status when the product depends on it). Never make CodeQL, scheduled, or advisory jobs required.
- Cache by lockfile hash and restore before install: `Swatinem/rust-cache@v2` (with `save-if: ${{ github.ref == 'refs/heads/main' }}`) for Cargo, `oven-sh/setup-bun@v2` plus `actions/cache` on `~/.bun/install/cache` for Bun, `actions/setup-node` cache or `actions/cache` for npm/pnpm, `actions/setup-python` with `cache: pip` or `astral-sh/setup-uv` with cache for Python. Playwright browsers are cached under `~/.cache/ms-playwright` keyed by the Playwright version.
- Rust: install the pinned toolchain with `dtolnay/rust-toolchain` (`rustup toolchain install` at most once per job, `--profile minimal`), set `CARGO_INCREMENTAL: 0`, `CARGO_TERM_COLOR: always`, `CARGO_NET_RETRY: 10`, `RUSTFLAGS: -D warnings` and `RUST_BACKTRACE: short` at workflow level, use `cargo nextest` or one `cargo test --workspace --locked` after a shared `cargo build --all-targets --locked`, run `clippy` and `fmt` once on Linux only, install tools with `taiki-e/install-action` or `cargo-binstall` instead of `cargo install`, and build release binaries in one job whose artifact every later job reuses. Never build the same crate twice in one workflow.
- Run the matrix Linux-first. A macOS or Windows job exists only when the product ships a native surface for that OS, runs the OS-specific tests only, and is never the only place a generic check runs. Split long serial script lists into parallel jobs that share one build artifact instead of one job that runs for twenty minutes.
- Skip work that cannot change the result inside the workflow: a change-detection job runs `dorny/paths-filter@v4` (it needs job permission `pull-requests: read`, and `predicate-quantifier: some-with-excludes` needs v4), and jobs whose inputs did not change skip through job-level `if:`. Never put `paths`, `paths-ignore`, or `branches-ignore` on the `pull_request` trigger of the workflow that produces `Required`: a skipped workflow never reports `Required`, and the pull request can never merge. Every `uses:` pins a major tag or a SHA with a version comment, and Dependabot keeps `github-actions` current weekly with auto-merge.
- Measure before and after: a CI change records the previous and new median wall time of the slowest workflow in its pull request body. Regressions that add more than a minute to `Required` are reverted forward the same day.
<!-- hraness-ci:end -->