keysat-root/AGENTS.md

AGENTS.md — Keysat workspace

Self-hosted, Bitcoin-native software licensing service running as a StartOS 0.4.x package, with four wire-compatible SDKs and a public landing/docs site.

This file holds whole-repo, every-session facts. Subsystem detail lives in scoped guides under docs/guides/ (symlinked to .claude/rules/ so Claude Code auto-loads each when you edit matching files). Before editing a subsystem, read its guide — see the index below.

Stack

• Daemon: Rust 1.88, axum, sqlx + SQLite, Ed25519 signing.
• Wrapper: TypeScript, @start9labs/start-sdk ^1.3.2, @vercel/ncc bundle, Node 22.
• SDKs: TS (npm), Rust (crates.io), Python (PyPI), Go (proxy.golang.org).
• Platform: StartOS 0.4.0.x (LXC under the hood — commands/paths reflect that, not Docker).
• Payment providers: BTCPay Server (required dep); Zaprite (optional, gated by zaprite_payments).

Subsystem guides (read before editing the area)

• Before editing the daemon source, read docs/guides/daemon-architecture.md.
• Before editing payment / provider / merchant-profile code, the scoped-connect gate, or migrations 0020–0022 + 0024–0025, read docs/guides/payments.md.
• Before touching self-license or tier-gating code, read docs/guides/licensing-tiers.md.
• Before changing the LIC1 wire format, crypto, or crosscheck fixtures, read docs/guides/crypto-wire-format.md.
• Before building, bumping the version, or editing the StartOS wrapper, read docs/guides/startos-packaging.md.
• Before editing the admin SPA (web/index.html), read docs/guides/admin-ui.md.
• Before editing public site/docs copy, read docs/guides/website-copy.md.
• Before building or changing any user-facing UI (landing, docs, admin SPA), read design/DESIGN.md and design/tokens.tokens.json and conform to them — the brand contract; pull colors/type/space/radii/shadows from the tokens, never hardcode off-scale values.
• Before adding/altering tests or relying on lint/CI, read docs/guides/testing.md.

Build / test / run (quick ref)

From licensing-service-startos/: make x86 | make arm | make universal | make install | make clean | npm run check. From licensing-service-startos/licensing-service/: cargo check | cargo build --release | cargo test | cargo test --test <suite> | cargo test <name>. Details, the version-bump-before-build rule, and release scripts: docs/guides/startos-packaging.md. Test suites, the no-CI / formatting-not-enforced status, and known-failing tests: docs/guides/testing.md.

Directory layout

licensing-service-startos/        daemon + StartOS wrapper (s9pk package source)
  licensing-service/src/          Rust daemon            → guides/daemon-architecture.md
  licensing-service/migrations/   SQLite migrations (numbered, additive)
  licensing-service/web/index.html  embedded admin SPA   → guides/admin-ui.md
  licensing-service/tests/        integration suites     → guides/testing.md
  startos/                        wrapper TS             → guides/startos-packaging.md
  onboarding-harness/             docs-onboarding test rig → onboarding-harness/README.md
  Dockerfile  Makefile  s9pk.mk   build pipeline
keysat-xyz-landing/ keysat-docs/   public sites → guides/website-copy.md
licensing-client-{rust,ts,python,go}/  the four SDK source repos
activate-license-template/        StartOS license-activation wrapper template (drop-in actions)
design/                           design contract (DESIGN.md + tokens.tokens.json) + brand/ assets; original Claude Design system archived in design/_imports/
plans/                            design specs (multi-provider-payment-model.md, keysat-smtp-emails.md)
tests/crosscheck/                 cross-language LIC1 verifier → guides/crypto-wire-format.md

Note: the daemon (licensing-service-startos, repo keysat), each SDK, and plans/ are separate git repos — commit code/plan changes in their own repo. The root Licensing repo (keysat-root) tracks only AGENTS.md + docs/guides/

• .claude/rules/ + EVALUATION.md (the latest full-eval report; overwritten each run, history in git log). Remotes differ per repo: the daemon's main tracks GitHub (origin, the public upstream) with a gitea backup — plain git push goes to GitHub, so also git push gitea main; root + plans are Gitea-only. Run git remote -v (full) and check what the branch tracks before pushing.

Conventions (whole-repo)

• Daemon licensed LicenseRef-Keysat-1.0 (custom, source-available); SDKs MIT.
• Commits in imperative mood, body only when the "why" isn't obvious. Sign as Keysat (Grant), not Claude — git user is Keysat.
• Direct push to main + run ~/.keysat/publish.sh is the authorized release flow until launch.
• Never rewrite user-facing copy outside the explicit scope of a request.

Never

• No AI co-authorship on commits or PRs (no "Co-Authored-By", no "Generated with…").
• Don't push --no-verify or bypass hooks unless explicitly authorized.
• Don't commit built artifacts (*.s9pk, keysat-*.s9pk, javascript/) or secrets — reference env-var names; real values live in ~/.keysat/filebrowser.env and /data/keysat-license.txt outside the repo.

Memory references

Operator-specific memories at ~/.claude/projects/-Users-macpro-Projects-keysat/memory/ (scan before a major change): keysat_release_workflow.md, no_unauthorized_copy_changes.md, keysat_admin_ui_pill_convention.md, startos_lxc.md, startos_registry_icon_unrenderable.md, keysat_open_threads.md.

Open TODOs

• riscv build target is unverified and not declared in the manifest; the wrapper Makefile now pins ARCHES to x86 arm so no target (even a bare make) attempts it. Revisit only if a riscv StartOS target appears.
• StartOS Community Registry submission is BLOCKED (needs a prepare.sh; plus icon-render and source-available-license questions to confirm with Start9) — detail in ROADMAP. Criteria themselves still unpublished; reach out when ready.
• Registry icon doesn't render in the StartOS marketplace (see guides/startos-packaging.md).
• Split audit:read out of the blanket :read scope into its own tier so a Read-only scoped key can read dashboards/licenses but NOT the full audit log (api/api_keys.rs::Role::grants). Deferred from the scoped-keys session.
• Operator action (manual; needs the master admin key — a read-only key can't write): grant unlimited_merchant_profiles to the Pro and Patron tiers on the live master. Confirmed 2026-06-16 against licensing.keysat.xyz that the slug is absent from all three keysat policies (Creator/Pro/Patron), from the master's own Patron self-license, and from the product entitlements_catalog. Steps: add the slug to the keysat product entitlements_catalog, then to the Pro + Patron policy entitlements (admin UI), then re-issue the master self-license so it takes effect.

Current state (2026-06-17)

• Live / canonical: 0.2.0:58 — universal s9pk at files.keysat.xyz/keysat.s9pk + GitHub v0.2.0-58; live box immense-voyage.local on :58. Migrations through 0025; four SDKs published; two public sites (keysat.xyz, docs.keysat.xyz) live. keysat-registry-landing deleted this session — local + all refs gone; the GitHub + Gitea remote repos still need operator deletion (gh needs delete_repo scope).

• This session — documentation audit + fix sweep across every public repo and both sites (all committed + pushed to GitHub + gitea; sites redeployed and verified live): daemon docs → 0.2.0 (admin-UI replaces the removed StartOS actions, Zaprite shipped, roles, runtime image, validate reasons); SDK READMEs fixed (the Rust crate name/version was a copy-paste blocker) and expanded (TS/Python tiers, seats, free-license); landing SDK snippets + tier-card fallback prices; docs change-tier example + install-step resequence; Makefile pins ARCHES=x86 arm. No daemon source touched.

• Start9 Community Registry: BLOCKED — functional criteria pass; needs prepare.sh + icon-render + source-available-license sign-off from Start9 (ROADMAP). (Note: registry.keysat.xyz works as a marketplace on a Start9 box; a plain browser/curl GET 404s by design — no HTML page is served there. Not an outage.)

• Next (priority): 1) Operator data action (master key): grant unlimited_merchant_profiles to Pro/Patron on live master (steps in Open TODOs). 2) Delete registry-landing GitHub + Gitea remotes. 3) 3 multi-profile UIs + split audit:read.

• Tests/build: docs-only session, no code touched; last full suite green (lib/api/subscriptions/upgrades/ worker/crosscheck/migrations through 0025), cargo check + npm run check clean. Debt (P2/P3) in ROADMAP.