mirror of
https://github.com/garrytan/gstack.git
synced 2026-08-20 21:17:19 +02:00
* test(helpers): shared skill-census helper with three explicit counts
physicalSkillFiles (symlinked dirs included, root router included),
authoredSkills (realpath-deduped, router excluded), registryEntries
(what ./setup registers: unique frontmatter names + _gstack-command).
One counting authority for the hermetic seeder, context-bill ground
truth, and the catalog-budget test — connect-chrome's dir symlink and
the root router otherwise produce three subtly different hand-rolled
censuses. Ported-wave foundation (C11).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix(evals): stop the harness grading itself
findPreviousRun excluded only the file being written, by name, so every
suite compared against _partial-e2e.json — the current run's own
accumulator, relabelled with the current tier just before each flush.
That is why every block read '+$0.00, +0s, Stable run, no regressions.'
This harness has never been able to detect a regression, and reassuring
output that cannot fail is worse than none. In-progress runs are now
excluded by role, and a run with nothing to compare against says NO
BASELINE instead of claiming stability.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit f3140b5245221fff7fb9411c7ec07c2ca11587b5)
* refactor(evals): shared partial-run predicate + finalized-run lookup
isPartialEval(data, filename) is the one place that decides what counts
as an in-progress accumulator (the _partial flag OR a _partial-prefixed
filename), and findLatestFinalizedRun(evalDir, tier) is the one place
that finds the newest real run — scanning the eval dir plus one level of
shards/<slug>/ subdirs, where the sharded paid runner points each
shard's collector. skill-budget-regression.test.ts's hand-rolled
findLatestRun (flag-blind: a flagged-but-renamed accumulator passed its
name check) is replaced by the shared helper.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit b55fcf6966366fd21a8cdc46de61aab6e1b1d100)
* feat(evals): register shipped skills for hermetic PTY children
Hermetic children get a config dir that deliberately seeds no skills —
right for children that install their own, fatal for the PTY family that
TYPES /office-hours or /plan-ceo-review: claude rejects the command as
Unknown before any model turn, so the plan-family gate smokes measure
nothing. hermeticSkillsConfigDir() is a second, opt-in config dir under
the same runRoot that mirrors ./setup's registration exactly (real dir
per registry name, SKILL.md + sections/ symlinks, frontmatter-name
resolution, _gstack-command root alias), driven by the shared
skill-census so connect-chrome's dir symlink collapses the same way
setup's idempotent overwrite does.
Ported from fork commit 03c4eca2, tree walk rewritten for the upstream
layout (top-level <skill>/SKILL.md dirs, no skills/ tree). Unit tests
are new: seed shape, census parity, symlink resolution, connect-chrome
collapse, idempotence, no-API-key seed.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 93dae6107b30ce453a07c2d342b60262bba6ce0b)
* feat(evals): seedSkills opt-in for PTY slash-command tests + tripwire
Wire ClaudePtyOptions.seedSkills through launchClaudePty: when set (and
hermetic, and no per-test CLAUDE_CONFIG_DIR override), the child gets
hermeticSkillsConfigDir() so typed /skill slash commands resolve instead
of dying as Unknown command before any model turn. Opted in at the three
runPlanSkill* helpers and the four direct-launch slash-command tests
(plan-design-with-ui, plan-ceo-mode-routing, autoplan-chain,
ship-idempotency).
New static tripwire (test/pty-skill-seeding-wiring.test.ts): any test
file that sends a slash command over the PTY must route through a
runPlanSkill* helper or pass seedSkills: true — an unseeded slash-command
test spends money and measures nothing. hermetic-wiring.test.ts now
blesses the repo-tree seeding path explicitly (config dir under runRoot,
symlinks into the repo checkout, never operator ~/.claude).
The CI "Register gstack skills for PTY smoke" step keeps a keep-me note:
container cross-mount symlinks defeat the TUI scanner and HOME is not
hermeticized, so the real-file copies there must survive this change.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 63c52269daaffb833b3105ea9b4b99be6df8fec7)
* refactor(evals): single shared paid-test-set module
test/helpers/paid-test-set.ts is now the one definition of which test
files are paid (the exact globs package.json's test:gate expands).
scripts/test-free-shards.ts derives its free/paid exclusion from it
instead of a private regex list, dropping the dead
browse/test/security-review-fullstack.test.ts pattern (file no longer
exists). The sharded paid runner derives its enumeration from the same
module, so a file added to one list can no longer silently miss the
other.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit a7f36479a6a1f3656452370f5883371f3cb65623)
* feat(evals): env-driven lazy eval dir + shard-aware store and tooling
Importing eval-store no longer spawns the gstack-slug subprocess: the
module-level DEFAULT_EVAL_DIR constant is now a memoized defaultEvalDir()
resolved at collector construction. Resolution order: explicit
constructor arg, then GSTACK_EVAL_DIR, then slug detection — so the
sharded paid runner can point each shard child at its own
<evalDir>/shards/<slug>/ dir with plain env, no --preload.
Runs collected under a shards/ subdir record their slug in the eval
JSON (EvalResult.shard). findPreviousRun scans one shards/<slug>/ level
and prefers same-slug priors, so each shard baselines against its own
history instead of whichever shard flushed last. eval:list,
eval:summary, and eval:compare enumerate the same one level of shard
subdirs; eval:compare's no-arg mode also stops picking an in-progress
accumulator as the after-run.
eval-watch stays flat (documented follow-up): it tails a single dir for
live progress and gains nothing from per-shard baselines until the
runner emits a merged stream.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit e1f53f7d9c7fe6b65877d843f2e25bd2e2d12ffd)
* feat(evals): sharded paid tier runner
scripts/test-paid-shards.ts runs the gate/periodic tier one Bun process
per test file, with an EXTERNAL wall-clock timeout that SIGKILLs the
shard's detached process group and an aggregate that distinguishes
passed / failed / timed-out / never-started — partial execution can no
longer read as a pass. Bun's native --shard/--isolate covers none of
this: no process-group kill (hung claude/codex PTY grandchildren
survive in-process isolation), no never-started taxonomy, no per-shard
env. Each shard child gets GSTACK_EVAL_DIR=<evalDir>/shards/<slug>/
(slug = test filename sans extension, stable across runs) so shard
baselines compare against their own prior runs.
Output classification lives in scripts/test-strict-output.ts (strict
exit-code derivation, incremental fail-line classifier, child signal
forwarding) so the runner and any future strict bun-test wrapper share
one implementation. Enumeration derives from the shared paid-test-set
module; tier exclusion fires only on an explicit whole-file
EVALS_TIER === '<other>' guard.
package.json gains test:gate:sharded / test:periodic:sharded, and
eval:bg:gate / eval:bg:periodic now run the sharded scripts with detach
timeouts sized to the worst case (gate: 49 shards x 30min / 4 jobs ~
6.2h -> 25200s; periodic: 59 -> 28800s).
test/paid-shards.test.ts pins enumeration, tier classification, and the
kill-and-continue property with a real busy-loop shard.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 5e76bd5931836257f896cedfe4e93912cb759c70)
* feat(security): hash-chained egress receipt ledger (core)
Port lib/egress-receipt from the v2 fork as TypeScript: writeReceipt
(sync, fail-closed via typed EGRESS_RECEIPT_FAILED), best-effort
writeOutcome, readLedger/listReceipts/verifyLedger, GSTACK_HOME ->
GSTACK_STATE_DIR -> ~/.gstack resolution, 0600 ledger under a 0700
security dir, and an mkdir spin lock (2.5s budget) with documented
>10s-mtime stale-lock reclaim.
Changes vs the fork:
- lastRawLine tail-reads the final 4KB instead of loading the whole
ledger, so appends stay O(1) as the file grows.
- WARN-at-size: past 25MB writeReceipt emits one self-explanatory
stderr warning per process (what the ledger is, how to inspect it,
rotation TODO); verifyLedger gains a sizeWarning field. Rotation
TODO carries the chain-genesis sketch (new generation's first record
embeds the prior file's tail hash).
bin/gstack-egress-receipt is a bun script bridging shell callers:
write|outcome subcommands, exit 3 + EGRESS_RECEIPT_FAILED on stderr on
failure; --no-payload records sha256:null for git-class ops.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 619726a3d77d987a2e50151a5727b3faaaf5fc6a)
* chore(bin): delete dead brain-consumer/reader scripts
bin/gstack-brain-consumer and bin/gstack-brain-reader are byte-identical
dead scripts that POST the repo URL + a Bearer token to a /ingest-repo
endpoint gbrain removed (docs/gbrain-sync.md already documents the
removal in past tense). No live references remain; CHANGELOG mentions
are historical.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 254ddc69fc5a0270fcc973e36b6a81766d835d2d)
* feat(security): shared shell receipt helpers
bin/gstack-egress-lib.sh (sourced library, gstack-gbrain-lib.sh
precedent) provides _receipted_curl and _receipted_git: write the
egress receipt BEFORE the send via gstack-egress-receipt, hand curl the
SAME payload file via --data-binary @file so the receipt hash matches
the wire bytes exactly, then append a best-effort outcome. Per-call
fail policy: 'closed' refuses the send (return 3, problem/cause/fix
message on stderr) and 'open' warns and proceeds. Payload temp files
are consumed immediately per call — no EXIT traps, since callers like
gstack-telemetry-sync own their own EXIT trap and a sourced trap would
clobber it.
Tested end-to-end against a local Bun.serve listener: receipt sha256
equals the sha256 of the bytes the listener received, fail-closed
refusal never touches the network and carries the problem/cause/fix
stderr shape, fail-open warns and proceeds.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 6d067dce2d4c8815dec98be551763c85a3671357)
* feat(security): receipt core shell sinks
Wire the three core bash egress sinks through gstack-egress-lib.sh:
- gstack-telemetry-sync: the batch POST now writes the payload to a
temp file, receipts those exact bytes fail-closed, and hands curl the
SAME file. On refusal nothing is sent and the cursor does not
advance, so the batch stays buffered for the next run. The HTTP
status is recorded as the receipt outcome.
- gstack-update-check: fail-open receipts (warn + proceed) on the
Supabase ping POST, both VERSION curls (via a local
_receipted_version_fetch helper that skips non-network schemes), and
git ls-remote. The ping receipt is written inside the backgrounded
subshell, so it can never block the script's exit.
- gstack-brain-sync: fail-closed git-class receipts. The push receipt
is written BEFORE the commit consumes the queue, so a refused receipt
leaves the queue intact and the next run retries the whole drain
(pinned by a new queue-intact-on-refusal test, including the
problem/cause/fix refusal message shape). The retry-path fetch and
retry push carry their own fail-closed receipts.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 3c60f699acceaf1c92a218874711e05fc17dca5d)
* feat(security): receipt TS module sinks + tunnel
writeReceipt (fail-closed, sha256:null — a subprocess or SDK owns the
wire bytes) before every TS-module network-bearing operation:
- bin/gstack-gbrain-sync.ts: before the gbrain code walk that ships
repo content to the user's gbrain DB (may be remote Postgres). A
refused receipt fails the stage with status refused-egress-receipt.
- bin/gstack-memory-ingest.ts: before the gbrain batch import of
transcript pages. A refused receipt returns a system_error verdict
without spawning the import.
- browse/src/server.ts: before both ngrok.forward call sites (start-up
BROWSE_TUNNEL=1 path and the /tunnel/start endpoint). A receipt
failure lands in the existing catch that tears the tunnel listener
back down and refuses the start.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 5677d618a48fcd0ae2b068bf868781d90f809cb5)
* feat(design): receipted fetch for OpenAI calls
design/src/receipted-fetch.ts wraps every api.openai.com call: a
content-free egress receipt (sink design-openai, sha256 of the JSON
body — hash only, never the body) is written BEFORE the send. Polarity
is FAIL-OPEN: user-facing generation must not die because an audit log
hiccuped, so a receipt failure warns on stderr and the call proceeds.
Streams pass through untouched (response bodies returned as-is;
non-string request bodies receipted as sha256:null rather than drained
to hash).
All ten call sites converted with per-command payload classes:
generate, variants (injected fetchFn passes through), iterate (both
threaded and fresh paths), evolve (image + screenshot analysis), check,
diff, design-to-code, memory.
Unit-tested with injected fetch: receipt-before-send ordering, stream
passthrough, and fail-open on an unwritable ledger.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit c0e5ff6639414ac2fd98e8ac3affb51401746b55)
* feat(security): receipt admin scripts + user git-ops (zero exceptions)
Wire the remaining shell egress through gstack-egress-lib.sh:
- gstack-gbrain-mcp-verify: both JSON-RPC probe POSTs (initialize +
tools/list) receipted fail-closed via payload files (hash == wire
bytes). A refused receipt lands in the NETWORK class — no send.
- gstack-security-dashboard / gstack-community-dashboard: the
community-pulse GETs receipted fail-open (read-only stats must not
break over an audit hiccup).
- gstack-gbrain-supabase-provision: api_call receipted fail-closed.
Each retry attempt hands the helper a fresh copy of the body file
(the helper consumes its payload). The receipt hashes the request
body only — the PAT never reaches the ledger or any log. Refusal
exits 8 without retrying.
- git-class sha256:null receipts, fail-open: gstack-artifacts-init
(ls-remote, initial push, fetch/pull recovery, retry push),
gstack-brain-restore (staging clone, existing-repo fetch),
gstack-session-update (self-update pull).
gstack-team-init needs no wiring: every git clone in it is inside an
echoed instruction string, not an executed command.
The lib now self-locates with shell builtins only (no dirname), so
sourcing works under the whitelist-PATH test harnesses.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit b8c5e2055b21ab72878b3e46f8047782ee65a11c)
* test(security): egress wiring tripwire + polarity contract
Static-grep tripwire pinning the egress-receipt wiring (threat model in
the header: the ledger is forensic observability of ATTEMPTED egress,
not an exfiltration control):
- Per-sink assertions: every wired TS module imports egress-receipt and
calls writeReceipt; every wired shell sink sources
gstack-egress-lib.sh with each network op under a receipt;
ngrok-proximity check for server.ts; every design api.openai.com call
routes through receiptedFetch.
- Absence assertions: the dead brain-consumer/reader scripts stay
deleted (lstat, so a dangling symlink also fails).
- Polarity table pinned as data (fail-closed: brain-sync,
memory-ingest, gbrain-sync, telemetry-sync, ngrok, mcp-verify,
supabase-provision; fail-open: design-openai, update-check,
dashboards, git-class user ops, context-bill --exact) plus per-file
polarity spot-checks.
- NEW-SINK SCANNER with zero KNOWN_UNWIRED: sweeps bin/, lib/,
scripts/, design/src, browse/src for curl, absolute-URL fetch(, and
git remote ops (never local rev-parse/get-url; heredoc bodies and
message strings excluded) and requires every hit to be receipted or
in a REASONED exemption list where each entry carries its why.
Preamble-generated skill prose documented out-of-scope in the header.
- Shebang tripwire: no bin/gstack-* file may carry a node shebang.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit ff69ceeafaf9c017d539b6ad77ff8f95b680b979)
* feat(cli): gstack-egress reader
bin/gstack-egress (bun) — the auditor's view of the receipts ledger:
- list: one row per receipt (what gstack ATTEMPTED to send), with
--since/--host/--sink filters and --json.
- verify: recompute the hash chain; exit 3 on tamper naming the first
broken line; prints the sizeWarning when the ledger passes 25MB.
- grants: what CAN leave, built on the upstream config keys only
(telemetry, artifacts_sync_mode, redact_repo_visibility,
redact_prepush_hook via gstack-config get) — each grant names its
file, key, and the exact revoke command.
CLI smoke tests spawn the real bin against a temp GSTACK_HOME,
including a broken-chain fixture asserting exit 3.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 9e24eca0f1069fea2ea69e7df4e9b256e93d59a3)
* feat(cli): context-bill — token bill-of-materials (stripped port)
lib/context-bill.ts, ported from the v2 fork and STRIPPED to the tiers
this repo's skills can exercise: ALWAYS-ON (per-skill frontmatter bytes
with dead-key and foreign-host-file flags), EAGER (SKILL.md + any
forced 'for every invocation' references), on-disk totals, --diff,
--budget, and --exact with the calibration table. The fork's
CONDITIONAL/TRANSITIVE/LAZY/FAST-PATH parsers understand only its
dispatcher layout and were dropped; the tier fields stay in the report
shape (empty/zero/null) so re-adding a parser is additive.
TOKEN_DIVISORS and their provenance docblock kept; --help notes
recalibration via --exact's calibration block.
Three upstream fixes over the fork:
(a) findSkillDirs treats the walk ROOT as a container — the repo root's
router SKILL.md is billed AND its children are walked (the fork
short-circuited and billed one skill); walkMd skips node_modules
and dot-directories.
(b) installed-tree layout: subdirs that are their own repo checkout
(a gstack/ clone inside ~/.claude/skills, detected by .git) are
skipped, and directory symlinks (connect-chrome) are followed with
a container-recursion cycle guard.
(c) ROUTER_KEYS widened to the upstream frontmatter contract {name,
description, version, allowed-tools, triggers, preamble-tier}.
--exact writes an egress receipt (sink context-bill-exact, host
api.anthropic.com) BEFORE any count_tokens POST; if the receipt cannot
be written the run degrades to the offline estimate with a warning —
nothing is sent unrecorded. bin/gstack-context-bill is the bun shim.
Tests: fixture-tree ledgers, the three fixes, --diff/--budget exit
codes, --exact with injected fetch (envelope subtraction, receipt
ordering, fail-open degradation), CLI smoke test, and ground truth
against THIS repo via test/helpers/skill-census.ts.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 675c19876b87ec927b555f5f64c7f93130b3de90)
* test(catalog): aggregate discovery-surface budget with ratchet protocol
Every host loads every skill's frontmatter name + description at
discovery, every session. applyCatalogTrim in scripts/gen-skill-docs.ts
shapes each description and the 160KB per-file warn covers body size,
but nothing capped the aggregate frontmatter — the catalog could grow
one reasonable-looking description at a time. This test is that
enforcement layer.
Measures the catalog via test/helpers/skill-census.ts authoredSkills
(symlink-deduped, root router counted separately as the _gstack-command
alias line item): 53 skills + router = 4,420 bytes = 1,105
token-equivalents today, asserted <= 1,150 (~4% headroom). Per-skill
sub-cap of 260 bytes (largest today: design-consultation at 229), plus
a non-empty-description check.
Failure messages are self-service ratchets: they print the new total,
the delta, and the update protocol (bump the constant AND the
derivation comment in the same commit; trim instead of grow for
existing descriptions). Parser handles folded block scalars
(description: >-) for fork parity; import-free by design so it
survives generator refactors.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit c106fb36f768181b80c257e5cff1cde4f435f9c0)
* fix(browse): extension token bootstrap moves to pinned-origin POST; /health carries no token
GET /health is now liveness/status only in every mode — both token
carve-outs (headed-mode disjunct AND chrome-extension:// Origin
disjunct) are removed. Token bootstrap is POST /extension-token on the
local listener: the Origin header must be exactly
chrome-extension://<GSTACK_EXTENSION_ID> and the Host header's hostname
must parse to 127.0.0.1 or localhost (parsed via new URL, never literal
equality — Host arrives as '127.0.0.1:34567'). Wrong origin/host → 403
with no detail. The tunnel surface 404s the endpoint (not in
TUNNEL_PATHS, verified by test).
The extension ID is pinned by a new "key" field (RSA public key) in
extension/manifest.json; browse/scripts/extension-id.ts reproduces the
ID derivation (first 16 bytes of SHA-256 of the DER public key, hex
mapped 0-9a-f → a-p). The private key is not committed anywhere —
unpacked/baked-in loads only need the public key.
Extension side: background.js bootstraps and refreshes the token via
POST /extension-token (403 → disconnected state); sidepanel.js direct
connect path does the same; sidepanel-terminal.js's dead /health token
fallback (read AUTH_TOKEN/authToken keys the server never sent,
hardcoded port) is replaced with the window.gstackAuthToken path.
MIGRATION NOTE: the manifest key pins the extension ID, so existing
installs' side-panel local state (saved port, snoozes) resets once —
explained in-product via a one-time notice (flag
gstack_id_migrated_v162). After upgrading the server, restart the
browser so the old service worker stops polling for a token GET /health
no longer serves.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit e9a0b6847a2d17fe6656a4686b4efd0c8380eb09)
* docs: correct stale compiled-binaries claim; file three egress/eval follow-ups
CLAUDE.md's compiled-binaries section claimed browse/dist binaries are
tracked by git and appear as modified in git status — false since
64d5a3e4 (v0.11.16.0) untracked them, and actively harmful: it trained
agents to ignore dist binaries in git status. The section now states
the truth (untracked + gitignored; a dist binary in git status means
someone force-added it) and covers make-pdf/dist too.
TODOS.md gains the three follow-ups filed by the v1.62 port-wave
reviews: ledger rotation with chain-genesis records, launch-nonce
token bootstrap, and eval-watch shard-awareness.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix: pre-landing review fixes for the v2 port wave
Review army (checklist + 5 specialists) + coverage/plan audits on the
assembled branch. Genuine correctness/security/hygiene fixes:
- test-paid-shards: strictTestExitCode now receives expectedFiles on the
real bun path, so a shard that runs fewer files than planned (harness
crash, nothing loaded) with exit 0 is no longer recorded 'passed' — the
invisible-non-execution class the runner exists to kill. Pinned by the
new test/strict-output.test.ts (also covers the chunk-boundary classifier).
- test-paid-shards: EVALS_TIER env is validated (gate|periodic) like the
--tier flag, so a typo can't self-skip every test and exit 0 green.
- package.json: test:periodic:sharded sets EVALS_ALL=1, restoring the
full-tier semantics the pre-shard script had (CI already set it; local
eval:bg:periodic silently under-measured without it).
- brain-sync.test: run() pins HOME to the temp home so gstack-artifacts-init
stops writing/clobbering the operator's real ~/.gstack-artifacts-remote.txt
every free-suite run; afterEach now also scrubs the current filename.
- egress-receipt: cap each receipt field at 512B so a serialized line always
fits the 4KB tail-read window — a longer line would make the next append
hash a truncated prior line and verifyLedger report a permanent false
TAMPER. warnLedgerSize short-circuits before statSync once fired (append
hot path).
- gstack-egress: import.meta.dir (Windows-safe) instead of new URL().pathname
so grants doesn't silently report defaults on Windows; strip control chars
from ledger-derived fields on render so a crafted receipt can't spoof the
auditor's view.
- extension/background.js + CLAUDE.md: renumber the identity-pin migration
refs v1.62 -> v1.63 (main claimed 1.62.0.0; this wave queue-advances).
- egress-receipt-wiring: pin lib/context-bill.ts unconditionally (both land
together now); drop the dead RunShardsOptions.tier field.
All fix-affected test files green; gate failures triaged as external-env
(codex/gemini CLI drift) or pre-existing (hermetic-canary fails identically
on base). Deferred polish tracked in the PR body + decision store.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* chore: bump version and changelog (v1.63.0.0)
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* docs: file TODO to harden plan-design-with-ui PTY detection
The v1.63 seedSkills change made this gate test execute for the first
time; it reliably times out because its terminal scraper can't parse the
(correctly-rendered) scope-gate AskUserQuestion out of a spinner-mangled
PTY buffer. Shipped skill behavior is correct — test-harness limitation.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* chore: re-slot release as v1.62.1.0 (PATCH per user)
Main claimed 1.62.0.0 while the wave was in flight; the user chose the
PATCH slot over queue-advancing MINOR. Renumbers the identity-pin
migration notice (now version-free flag name so a re-slot never orphans
an already-set flag), the CLAUDE.md /health note, the CHANGELOG heading,
and the TODOS section titles.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix(test): stop hard-requiring the literal ok) case label in gbrain-refresh guards
The extractor grepped for 'ok)' but the case label grew to
ok|timeout|thin-client) (#1964, #2051), so the whole file errored on
import — the free suite's only red for months. The extractor now matches
any label starting with ok and its alternations; all 7 guard assertions
run again.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix(test): hermetic-canary probes with ${VAR:-} so nounset shells can't fail success
The probe echoed bare $CONDUCTOR_WORKSPACE_PATH — when scrubbing WORKS
the var is unset, and under a nounset shell the echo errors, failing the
canary exactly when isolation succeeds. Defaulted expansions assert
identically under any shell. Fails identically on base; fixed here.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix(evals): absorb codex/gemini CLI drift; external-service tests go periodic-tier
- codex exec gains --skip-git-repo-check: newer CLIs refuse exec in an
untrusted non-git dir (our temp skill dirs) — empirically verified.
- gemini: --skip-trust was removed in gemini-cli 0.34 (argv parse error);
dropped from the session runner and the benchmark adapter. A present-
but-unusable CLI (deprecated individual code-assist auth path) now
classifies as SKIP, not a false adapter failure; the benchmark live
smoke skips on auth/rate_limit error codes (environmental) while still
failing on timeout/unknown (the drift classes it exists to catch).
- codex-e2e, gemini-e2e, and benchmark-providers gain the canonical
whole-file EVALS_TIER === 'periodic' guard per CLAUDE.md tiering rule 3
(external service -> periodic) — the sharded gate runner now excludes
all three (gate: 45 -> 42 shards).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix(evals): parse single-logical-line AskUserQuestions in the PTY runner
When the PTY reflows a boxed AUQ, ALL options land on ONE logical line
after stripAnsi — parseNumberedOptions parsed one option per line, found
only '1.', and the >=2 check failed forever while the correct question
sat on screen (plan-design-with-ui timed out this way twice, with the
rendered scope-gate AUQ visible in both failure buffers). The cursor
line is now parsed as a stream of ascending N. tokens; DEC cursor-
visibility residue is stripped before matching; plan-design-with-ui's
budgets grow to fit observed ~6min preamble+thinking latency. Pinned by
test/pty-auq-single-line.test.ts using the real failure buffers; all 142
existing parser-consumer unit tests still green.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* chore: restore v1.63.0.0 (MINOR — user-confirmed final slot)
The wave ships new capability (egress receipts + two CLIs, sharded paid
runner, hermetic skill seeding) at ~8K lines — MINOR scale per the
scale-aware bump rules. Supersedes the brief v1.62.1.0 re-slot; the
version-free migration flag means no state churn from the renumber.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* test: spell out AskUserQuestion in the PTY single-line fixture
Rename test/pty-auq-single-line.test.ts to
test/pty-askuserquestion-single-line.test.ts and expand the AUQ
abbreviation in identifiers and comments. House style writes
AskUserQuestion in full in filenames, identifiers, and comments.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* docs: sync every doc surface with the v1.63 release
/document-release audit (4-lane, all claims verified against branch code):
- README: gstack-egress + gstack-context-bill rows in the standalone-binaries
table; Privacy & Telemetry gains the receipted-egress bullet (attempted-
egress framing per the shipped threat model).
- ARCHITECTURE: /health is liveness-only, POST /extension-token endpoint row
+ bootstrap mechanics paragraph; new Egress receipt ledger subsection under
Security model; eval persistence covers the sharded runner, GSTACK_EVAL_DIR,
and the finalized-run baseline rule.
- CLAUDE.md: sharded test scripts in Commands; sharded semantics in the
detached-evals section; PTY skill seeding in the hermetic section; egress
invariant block beside the other server-egress invariants; catalog-budget
ceiling beside the 160KB token ceiling; project-tree entries for
lib/egress-receipt.ts, lib/context-bill.ts, scripts/test-paid-shards.ts.
- CONTRIBUTING: seedSkills + live-tree seeding in the hermetic paragraph;
sharded runner in detached runs; catalog-budget in the Tier 1 list.
- BROWSER: extension token bootstrap section, tunnel egress receipts section,
identity-pin migration note in manual install.
- REMOTE_BROWSER_ACCESS: tunnel-start receipt bullet in the security model.
- gbrain docs: /sync-gbrain + brain-sync egress-receipt behavior documented;
dead consumer-token instructions removed (consumer machinery deleted this
release); new fail-closed refusal added to the error catalog.
- CHANGELOG: measured-vs-ceiling catalog numbers, contributor notes for the
external-service tier move and the PTY single-line AskUserQuestion parser,
release date.
- TODOS: /health token-distribution TODO resolved by this release, removed;
port-wave follow-up sections re-labeled to the shipped version.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* docs: sweep drift that predates this release
Surfaced by the /document-release audit; every fix verified against the
current binaries:
- gstack-brain-init was replaced by gstack-artifacts-init in v1.27.0.0
(hard-delete, no compat shim), but README, USING_GBRAIN_WITH_GSTACK,
docs/gbrain-sync.md, and docs/gbrain-sync-errors.md still instructed
users to run it — command-not-found on every follow. Same sweep updates
~/.gstack-brain-remote.txt to the canonical ~/.gstack-artifacts-remote.txt
(legacy name still honored on restore, noted where users copy the file).
- gbrain-sync-errors.md headings re-matched to the literal messages the
binaries print today (the doc's whole value is grep-by-exact-message):
'gstack-artifacts-init: ~/.gstack/ is already a git repo pointing at:',
'Remote not reachable via SSH:', 'Failed to create or find ...'. The
already-a-repo fix now leads with the command's own set-url suggestion.
- docs/gbrain-sync.md 'Under the hood' linked a plan file that does not
exist in the repo; replaced with the decisions themselves.
- SIDEBAR_MESSAGE_FLOW startup timeline: /pty-session responds with
{terminalPort, sessionId, attachToken, leaseExpiresAt} (v1.44 shape,
verified at browse/src/server.ts:1860), not the retired
{terminalPort, ptySessionToken} pair.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* docs: fold the Codex accuracy review of the release docs
Six findings, all verified against source before fixing:
1. 'Every send writes a receipt' overclaimed — fail-open sinks proceed with
a stderr warning when the receipt write fails, so a fail-open send can go
unrecorded (lib/egress-receipt.ts:8-14). Descriptive prose now says so;
the receipted framing keeps 'attempted'.
2. 'Receipts hash the request body' is wrong for subprocess-owned sends —
git pushes record sha256: null (lib/egress-receipt.ts:71).
3. 'grants shows every consent in force' overclaimed — it reports the four
standing config settings (bin/gstack-egress:139-181). Reworded in
README, ARCHITECTURE, and the CHANGELOG entry.
4. 'Zero-exception scanner' vs reality: the new-sink scanner carries a
reasoned SCANNER_EXEMPT list (user-directed fetches, probes, instruction
strings, skill prose). CLAUDE.md now names it.
5. Error-catalog cause/fix for the receipt refusal: the writer mkdirs the
ledger dir itself, so 'missing' isn't a cause and bare chmod fails when
it is absent — cause reworded, fix is mkdir -p && chmod.
6. gbrain-sync first-run steps described the retired binary's behavior:
default repo is gstack-artifacts-$USER, and init PRINTS the gbrain
hookup command (never auto-executes; bin/gstack-artifacts-init:384-419).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Sinabina <sinabina@Sinabinas-MacBook-Pro-4.local>
1004 lines
38 KiB
TypeScript
1004 lines
38 KiB
TypeScript
/**
|
|
* gstack context-bill — token bill-of-materials for an installed gstack skills tree.
|
|
*
|
|
* Read-only, offline, deterministic. Ledgers over pure file reads:
|
|
* ALWAYS-ON per-skill YAML frontmatter bytes (what every session's skill
|
|
* scanner loads), flagging frontmatter keys the router never
|
|
* reads and foreign-host files in scanner scope.
|
|
* EAGER SKILL.md plus any references the skill's prose forces "for
|
|
* every invocation".
|
|
*
|
|
* This is a STRIPPED port of the v2 fork's six-ledger bill: the CONDITIONAL,
|
|
* TRANSITIVE, LAZY, and FAST-PATH parsers only understand the fork's
|
|
* dispatcher-skill layout, which this repo's skills don't use, so they were
|
|
* dropped rather than shipped dead. The tier fields stay in the report shape
|
|
* (empty arrays / zeros / nulls) so re-adding a parser is additive: nothing
|
|
* downstream needs a schema change.
|
|
*
|
|
* Token figures come from one of two sources, always named in the output:
|
|
* ESTIMATE (default, offline) bytes / TOKEN_DIVISOR, calibrated against real
|
|
* count_tokens measurements.
|
|
* EXACT (--exact, opt-in) Anthropic's count_tokens for every file the
|
|
* bill touches. Sends file content off-machine,
|
|
* so it is never implicit: an egress receipt is
|
|
* written before the POSTs (sink
|
|
* 'context-bill-exact'), and if the receipt
|
|
* cannot be written the run degrades to the
|
|
* offline estimate with a warning instead of
|
|
* sending unrecorded.
|
|
* Both bytes and tokens are always shown, and the estimate's measured error
|
|
* band is printed with it. The tool never writes state anywhere (the egress
|
|
* receipt under --exact is the one exception, and it is the point).
|
|
*/
|
|
import fs from "node:fs";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { writeReceipt } from "./egress-receipt";
|
|
|
|
const FORCED_PHRASE = "for every invocation";
|
|
// Backticked reference in prose. `<...>` is excluded: a path template such as
|
|
// `references/templates/<Name>.md` names a family of files, not one on disk.
|
|
const PROSE_REF = /`(references\/[^`<>]+\.md)`/g;
|
|
// Upstream frontmatter contract: the keys the router/host actually reads.
|
|
const ROUTER_KEYS = new Set(["name", "description", "version", "allowed-tools", "triggers", "preamble-tier"]);
|
|
// Skill-shaped files other hosts drop into scanner scope.
|
|
const FOREIGN_SKILL_FILE = /^(skill\.(ya?ml|json)|agents?\.md|\.cursorrules|\.windsurfrules)$/i;
|
|
|
|
/**
|
|
* Bytes per token, per content class, fitted to real count_tokens measurements.
|
|
*
|
|
* Calibration corpus: 219 `.md` skill files plus their frontmatter blocks,
|
|
* measured 2026-08-01 against `claude-opus-4-5` with the per-request message
|
|
* envelope subtracted. Regenerate with `gstack-context-bill <tree> --exact
|
|
* --json` and read the `calibration` block, which grades this estimate
|
|
* against measured counts file by file.
|
|
*
|
|
* Why classes and not one divisor: measured bytes-per-token spans 2.36 to 4.72
|
|
* across the corpus, and the spread is largely structural. Legacy specialist
|
|
* modules cluster at 3.47 (n=50, range 3.10-3.83) and SKILL.md bodies at 4.21
|
|
* (n=50, range 3.65-4.50) -- tight enough that one divisor for both charges
|
|
* some ledgers about 19% under while charging others about right. Splitting on
|
|
* path roles cuts mean per-file error from 11.1% to 7.4% and removes the
|
|
* systematic bias, which is what a cost tool owes.
|
|
*
|
|
* What classes do NOT fix: the `reference` class is genuinely heterogeneous
|
|
* (2.36 to 4.72 -- dense path/table files sit at one end, prose at the other),
|
|
* so worst-case per-file error stays near 40%. Use --exact when a single
|
|
* file's number has to be right.
|
|
*
|
|
* These divisors are tokenizer-specific. Opus 4.7 and later tokenize
|
|
* differently; on those models use --exact.
|
|
*/
|
|
export const TOKEN_DIVISORS: Record<string, number> = {
|
|
frontmatter: 3.99,
|
|
skillmd: 4.21,
|
|
reference: 4.15,
|
|
artifact: 3.67,
|
|
legacy: 3.47,
|
|
};
|
|
/** Fallback for content that matches no class. Corpus-wide aggregate. */
|
|
export const TOKEN_DIVISOR = 3.9;
|
|
/** Worst-case per-file residual of the estimate over the calibration corpus. */
|
|
export const TOKEN_ESTIMATE_ERROR_PCT = 40;
|
|
|
|
export type TokensOf = (key: string, bytes: number) => number;
|
|
|
|
export interface RefEntry {
|
|
path: string;
|
|
bytes: number;
|
|
tokens: number;
|
|
missing: boolean;
|
|
via?: string;
|
|
condition?: string;
|
|
}
|
|
|
|
export interface SkillBill {
|
|
name: string;
|
|
dir: string;
|
|
frontmatterBytes: number;
|
|
frontmatterTokens: number;
|
|
frontmatterKeys: string[];
|
|
deadKeys: string[];
|
|
skillMdBytes: number;
|
|
skillMdTokens: number;
|
|
forcedRefs: RefEntry[];
|
|
eagerBytes: number;
|
|
eagerTokens: number;
|
|
/** Stripped tiers: kept in the shape (empty/zero/null) so re-adding the
|
|
* fork's parsers is additive. */
|
|
fastPath: null;
|
|
conditionalRefs: RefEntry[];
|
|
conditionalBytes: number;
|
|
conditionalTokens: number;
|
|
transitiveRefs: RefEntry[];
|
|
transitiveBytes: number;
|
|
transitiveTokens: number;
|
|
perInvocationBytes: number;
|
|
perInvocationTokens: number;
|
|
routeCeiling: { label: string; bytes: number; tokens: number } | null;
|
|
lazy: { label: string; modules: RefEntry[]; bytes: number; tokens: number }[];
|
|
orphans: RefEntry[];
|
|
foreignFiles: { path: string; bytes: number; tokens: number }[];
|
|
totalMdBytes: number;
|
|
totalMdTokens: number;
|
|
}
|
|
|
|
/**
|
|
* Content class from the path role. Legacy/artifact roles are kept even
|
|
* though their tiers are stripped: the divisors are per-content measurements
|
|
* and --exact calibration still grades them.
|
|
*/
|
|
export function contentClass(key: string): string {
|
|
if (key.endsWith("#frontmatter")) return "frontmatter";
|
|
if (/references[/\\]legacy[/\\]/.test(key)) return "legacy";
|
|
if (/references[/\\](artifacts|sections|support)[/\\]/.test(key)) return "artifact";
|
|
if (/(^|[/\\])SKILL\.md$/.test(key)) return "skillmd";
|
|
if (/references[/\\]/.test(key)) return "reference";
|
|
return "other";
|
|
}
|
|
|
|
/** Path-less callers get the corpus-wide aggregate divisor. */
|
|
export function estimateTokens(bytes: number): number {
|
|
return Math.round(bytes / TOKEN_DIVISOR);
|
|
}
|
|
|
|
/** Default token source: the calibrated offline estimate. Unrounded, so sums round once. */
|
|
function estimateTokensOf(key: string, bytes: number): number {
|
|
return bytes / (TOKEN_DIVISORS[contentClass(key)] ?? TOKEN_DIVISOR);
|
|
}
|
|
|
|
function bytesOf(file: string): number | null {
|
|
try {
|
|
const st = fs.statSync(file);
|
|
return st.isFile() ? st.size : null;
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
function refEntry(skillDir: string, rel: string, tokensOf: TokensOf): RefEntry {
|
|
const abs = path.join(skillDir, rel);
|
|
const bytes = bytesOf(abs);
|
|
return {
|
|
path: rel,
|
|
bytes: bytes ?? 0,
|
|
tokens: bytes == null ? 0 : tokensOf(abs, bytes),
|
|
missing: bytes == null,
|
|
};
|
|
}
|
|
|
|
function sumBytes(entries: { bytes: number }[]): number {
|
|
return entries.reduce((n, e) => n + e.bytes, 0);
|
|
}
|
|
|
|
function sumTokens(entries: { tokens: number }[]): number {
|
|
return entries.reduce((n, e) => n + e.tokens, 0);
|
|
}
|
|
|
|
/** Cache key for a SKILL.md's frontmatter block, which is a slice, not a whole file. */
|
|
function frontmatterKey(skillMdPath: string): string {
|
|
return `${skillMdPath}#frontmatter`;
|
|
}
|
|
|
|
function parseFrontmatter(text: string): { bytes: number; keys: string[]; block: string } {
|
|
if (!text.startsWith("---")) return { bytes: 0, keys: [], block: "" };
|
|
const end = text.indexOf("\n---", 3);
|
|
if (end === -1) return { bytes: 0, keys: [], block: "" };
|
|
const closeEol = text.indexOf("\n", end + 1);
|
|
const block = text.slice(0, closeEol === -1 ? text.length : closeEol + 1);
|
|
const inner = text.slice(text.indexOf("\n") + 1, end);
|
|
const keys: string[] = [];
|
|
for (const line of inner.split("\n")) {
|
|
const m = /^([A-Za-z0-9_-]+)\s*:/.exec(line);
|
|
if (m) keys.push(m[1]);
|
|
}
|
|
return { bytes: Buffer.byteLength(block, "utf8"), keys, block };
|
|
}
|
|
|
|
/**
|
|
* Every .md file under a tree, for the on-disk total and for exact
|
|
* measurement. Skips node_modules and dot-directories: a skills tree that is
|
|
* also a repo checkout (dev symlink installs) would otherwise bill its
|
|
* dependency tree and CI state as skill content.
|
|
*/
|
|
export function walkMd(dir: string): string[] {
|
|
const out: string[] = [];
|
|
let entries: fs.Dirent[];
|
|
try {
|
|
entries = fs.readdirSync(dir, { withFileTypes: true });
|
|
} catch {
|
|
return out;
|
|
}
|
|
for (const e of entries) {
|
|
if (e.name.startsWith(".") || e.name === "node_modules") continue;
|
|
const p = path.join(dir, e.name);
|
|
if (e.isDirectory()) out.push(...walkMd(p));
|
|
else if (e.isFile() && e.name.endsWith(".md")) out.push(p);
|
|
}
|
|
return out;
|
|
}
|
|
|
|
function totalMd(dir: string, tokensOf: TokensOf): { bytes: number; tokens: number } {
|
|
let bytes = 0;
|
|
let tokens = 0;
|
|
for (const p of walkMd(dir)) {
|
|
const b = bytesOf(p) ?? 0;
|
|
bytes += b;
|
|
tokens += tokensOf(p, b);
|
|
}
|
|
return { bytes, tokens };
|
|
}
|
|
|
|
export function parseSkill(skillDir: string, name: string, tokensOf: TokensOf = estimateTokensOf): SkillBill {
|
|
const skillMdPath = path.join(skillDir, "SKILL.md");
|
|
const text = fs.readFileSync(skillMdPath, "utf8");
|
|
const skillMdBytes = bytesOf(skillMdPath) ?? 0;
|
|
const skillMdTokens = tokensOf(skillMdPath, skillMdBytes);
|
|
const fm = parseFrontmatter(text);
|
|
// The frontmatter block is a slice of SKILL.md, so it carries its own key.
|
|
const frontmatterTokens = tokensOf(frontmatterKey(skillMdPath), fm.bytes);
|
|
const deadKeys = fm.keys.filter((k) => !ROUTER_KEYS.has(k));
|
|
|
|
// EAGER: references a prose CLAUSE forces "for every invocation". Clause
|
|
// granularity matters: a line can carry a forced clause and a conditional
|
|
// one, and only the forced clause's references are eager. Routing tables
|
|
// never count (they were the fork's LAZY tier).
|
|
const forcedRefs: RefEntry[] = [];
|
|
const seenForced = new Set<string>();
|
|
for (const line of text.split("\n")) {
|
|
if (line.trim().startsWith("|")) continue;
|
|
for (const clause of line.split(/(?<=[.;])\s+/)) {
|
|
if (!clause.includes(FORCED_PHRASE)) continue;
|
|
for (const m of clause.matchAll(PROSE_REF)) {
|
|
const p = m[1];
|
|
if (seenForced.has(p)) continue;
|
|
seenForced.add(p);
|
|
forcedRefs.push(refEntry(skillDir, p, tokensOf));
|
|
}
|
|
}
|
|
}
|
|
|
|
// Foreign-host skill files sitting next to SKILL.md.
|
|
const foreignFiles: { path: string; bytes: number; tokens: number }[] = [];
|
|
for (const entry of fs.readdirSync(skillDir, { withFileTypes: true })) {
|
|
if (entry.isFile() && FOREIGN_SKILL_FILE.test(entry.name)) {
|
|
const abs = path.join(skillDir, entry.name);
|
|
const bytes = bytesOf(abs) ?? 0;
|
|
foreignFiles.push({ path: entry.name, bytes, tokens: tokensOf(abs, bytes) });
|
|
}
|
|
}
|
|
|
|
const total = totalMd(skillDir, tokensOf);
|
|
const eagerBytes = skillMdBytes + sumBytes(forcedRefs);
|
|
const eagerTokens = skillMdTokens + sumTokens(forcedRefs);
|
|
return {
|
|
name,
|
|
dir: skillDir,
|
|
frontmatterBytes: fm.bytes,
|
|
frontmatterTokens,
|
|
frontmatterKeys: fm.keys,
|
|
deadKeys,
|
|
skillMdBytes,
|
|
skillMdTokens,
|
|
forcedRefs,
|
|
eagerBytes,
|
|
eagerTokens,
|
|
// Stripped tiers, shape preserved (see the module docblock).
|
|
fastPath: null,
|
|
conditionalRefs: [],
|
|
conditionalBytes: 0,
|
|
conditionalTokens: 0,
|
|
transitiveRefs: [],
|
|
transitiveBytes: 0,
|
|
transitiveTokens: 0,
|
|
// With the conditional/transitive tiers stripped, the per-invocation
|
|
// ceiling IS the eager figure. Re-adding a tier changes these sums only.
|
|
perInvocationBytes: eagerBytes,
|
|
perInvocationTokens: eagerTokens,
|
|
routeCeiling: null,
|
|
lazy: [],
|
|
orphans: [],
|
|
foreignFiles,
|
|
totalMdBytes: total.bytes,
|
|
totalMdTokens: total.tokens,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Every skill directory under a tree.
|
|
*
|
|
* Root-as-container (upstream fix): this repo's ROOT has a router SKILL.md
|
|
* AND fifty skill directories under it — the fork's walker short-circuited at
|
|
* the root and billed one "skill". The root is counted as a skill (the router
|
|
* costs what it costs) and the walk continues into its children. A NON-root
|
|
* dir with SKILL.md is still a leaf: its subtree (references/, test
|
|
* fixtures) is never another skill.
|
|
*
|
|
* Repo-checkout subdirs are skipped (upstream install layout fix): an
|
|
* installed ~/.claude/skills tree contains flat skill dirs PLUS a full gstack
|
|
* repo checkout (`gstack/`, with .git). Its nested SKILL.md files are the
|
|
* repo's sources, not installed skills of the tree being billed.
|
|
*
|
|
* Directory symlinks are followed (setup's shell glob follows them, so a
|
|
* symlinked skill like connect-chrome/ is real scanner load); a realpath
|
|
* seen-set breaks cycles.
|
|
*/
|
|
export function findSkillDirs(root: string): string[] {
|
|
const out: string[] = [];
|
|
const visited = new Set<string>();
|
|
const walk = (dir: string, isRoot: boolean) => {
|
|
let entries: fs.Dirent[];
|
|
try {
|
|
entries = fs.readdirSync(dir, { withFileTypes: true });
|
|
} catch {
|
|
return;
|
|
}
|
|
if (entries.some((e) => e.isFile() && e.name === "SKILL.md")) {
|
|
out.push(dir);
|
|
// Two symlinked paths to the same skill dir are BOTH billed (each is
|
|
// real scanner load); only container recursion below is cycle-guarded.
|
|
if (!isRoot) return;
|
|
}
|
|
// Cycle guard for container recursion (a symlink loop of directories).
|
|
let real: string;
|
|
try {
|
|
real = fs.realpathSync(dir);
|
|
} catch {
|
|
return;
|
|
}
|
|
if (visited.has(real)) return;
|
|
visited.add(real);
|
|
for (const e of entries) {
|
|
if (e.name.startsWith(".") || e.name === "node_modules") continue;
|
|
const child = path.join(dir, e.name);
|
|
let isDir = e.isDirectory();
|
|
if (!isDir && e.isSymbolicLink()) {
|
|
try {
|
|
isDir = fs.statSync(child).isDirectory();
|
|
} catch {
|
|
continue; // dangling symlink
|
|
}
|
|
}
|
|
if (!isDir) continue;
|
|
if (fs.existsSync(path.join(child, ".git"))) continue; // repo checkout, not a skill
|
|
walk(child, false);
|
|
}
|
|
};
|
|
walk(path.resolve(root), true);
|
|
return out.sort();
|
|
}
|
|
|
|
export interface Bill {
|
|
root: string;
|
|
tokenSource: string;
|
|
tokenEstimate: Record<string, number>;
|
|
tokenEstimateErrorPct: number;
|
|
calibration?: Calibration;
|
|
skills: SkillBill[];
|
|
totals: {
|
|
skillCount: number;
|
|
alwaysOnBytes: number;
|
|
alwaysOnTokens: number;
|
|
eagerBytesBySkill: Record<string, number>;
|
|
eagerTokensBySkill: Record<string, number>;
|
|
perInvocationBytesBySkill: Record<string, number>;
|
|
perInvocationTokensBySkill: Record<string, number>;
|
|
totalMdBytes: number;
|
|
totalMdTokens: number;
|
|
};
|
|
}
|
|
|
|
export function buildBill(
|
|
root: string,
|
|
{ tokensOf = estimateTokensOf, tokenSource, calibration }: {
|
|
tokensOf?: TokensOf;
|
|
tokenSource?: string;
|
|
calibration?: Calibration;
|
|
} = {},
|
|
): Bill {
|
|
const resolved = path.resolve(root);
|
|
if (!fs.existsSync(resolved)) throw new Error(`No such tree: ${resolved}`);
|
|
const skills = findSkillDirs(resolved).map((dir) =>
|
|
parseSkill(dir, path.relative(resolved, dir) || path.basename(resolved), tokensOf),
|
|
);
|
|
const total = skills.reduce((n, s) => n + s.totalMdBytes, 0);
|
|
const totalTokens = skills.reduce((n, s) => n + s.totalMdTokens, 0);
|
|
return {
|
|
root: resolved,
|
|
// Named so a reader never has to guess whether a figure was measured.
|
|
tokenSource: tokenSource ?? "estimate: calibrated bytes/token per content class",
|
|
tokenEstimate: TOKEN_DIVISORS,
|
|
tokenEstimateErrorPct: tokenSource ? 0 : TOKEN_ESTIMATE_ERROR_PCT,
|
|
// Present only under --exact: how far the offline estimate was off, per file.
|
|
...(calibration ? { calibration } : {}),
|
|
skills,
|
|
totals: {
|
|
skillCount: skills.length,
|
|
alwaysOnBytes: skills.reduce((n, s) => n + s.frontmatterBytes, 0),
|
|
alwaysOnTokens: skills.reduce((n, s) => n + s.frontmatterTokens, 0),
|
|
eagerBytesBySkill: Object.fromEntries(skills.map((s) => [s.name, s.eagerBytes])),
|
|
eagerTokensBySkill: Object.fromEntries(skills.map((s) => [s.name, Math.round(s.eagerTokens)])),
|
|
perInvocationBytesBySkill: Object.fromEntries(skills.map((s) => [s.name, s.perInvocationBytes])),
|
|
perInvocationTokensBySkill: Object.fromEntries(
|
|
skills.map((s) => [s.name, Math.round(s.perInvocationTokens)]),
|
|
),
|
|
totalMdBytes: total,
|
|
totalMdTokens: totalTokens,
|
|
},
|
|
};
|
|
}
|
|
|
|
export interface DiffRow {
|
|
ledger: string;
|
|
label: string;
|
|
before: number;
|
|
after: number;
|
|
delta: number;
|
|
tokenDelta: number;
|
|
}
|
|
|
|
export function diffBills(a: Bill, b: Bill): { rows: DiffRow[]; grew: boolean } {
|
|
const rows: DiffRow[] = [];
|
|
const push = (ledger: string, label: string, before: number, after: number, tokBefore: number, tokAfter: number) => {
|
|
if (before !== after) {
|
|
rows.push({ ledger, label, before, after, delta: after - before, tokenDelta: Math.round(tokAfter - tokBefore) });
|
|
}
|
|
};
|
|
const skillNames = [...new Set([...a.skills, ...b.skills].map((s) => s.name))].sort();
|
|
for (const name of skillNames) {
|
|
const sa = a.skills.find((s) => s.name === name);
|
|
const sb = b.skills.find((s) => s.name === name);
|
|
push(
|
|
"always-on", name,
|
|
sa?.frontmatterBytes ?? 0, sb?.frontmatterBytes ?? 0,
|
|
sa?.frontmatterTokens ?? 0, sb?.frontmatterTokens ?? 0,
|
|
);
|
|
push("eager", name, sa?.eagerBytes ?? 0, sb?.eagerBytes ?? 0, sa?.eagerTokens ?? 0, sb?.eagerTokens ?? 0);
|
|
// Stripped tiers stay in the diff contract so re-adding them is additive.
|
|
push(
|
|
"conditional", name,
|
|
sa?.conditionalBytes ?? 0, sb?.conditionalBytes ?? 0,
|
|
sa?.conditionalTokens ?? 0, sb?.conditionalTokens ?? 0,
|
|
);
|
|
push(
|
|
"transitive", name,
|
|
sa?.transitiveBytes ?? 0, sb?.transitiveBytes ?? 0,
|
|
sa?.transitiveTokens ?? 0, sb?.transitiveTokens ?? 0,
|
|
);
|
|
}
|
|
rows.sort((x, y) => Math.abs(y.delta) - Math.abs(x.delta));
|
|
const grew =
|
|
b.totals.alwaysOnBytes > a.totals.alwaysOnBytes ||
|
|
rows.some((r) => ["eager", "conditional", "transitive"].includes(r.ledger) && r.delta > 0);
|
|
return { rows, grew };
|
|
}
|
|
|
|
export interface BudgetViolation {
|
|
ceiling: string;
|
|
limit: number;
|
|
actual: number | null;
|
|
files: string[];
|
|
}
|
|
|
|
/**
|
|
* Budget file: user-authored plain JSON, ceilings in ~tokens.
|
|
* { "alwaysOnTotal": 4000, "eagerPerInvocation": { "qa": 5000 },
|
|
* "perInvocation": { "qa": 9000 } }
|
|
* With the conditional/transitive tiers stripped, `perInvocation` and
|
|
* `routeCeiling` gate the same figure as `eagerPerInvocation`; the keys stay
|
|
* accepted so budgets survive the tiers returning.
|
|
*/
|
|
export function checkBudget(bill: Bill, budget: Record<string, any>): BudgetViolation[] {
|
|
const violations: BudgetViolation[] = [];
|
|
if (typeof budget.alwaysOnTotal === "number") {
|
|
const actual = Math.round(bill.totals.alwaysOnTokens);
|
|
if (actual > budget.alwaysOnTotal) {
|
|
violations.push({
|
|
ceiling: "alwaysOnTotal",
|
|
limit: budget.alwaysOnTotal,
|
|
actual,
|
|
files: bill.skills.map((s) => `${s.name}/SKILL.md (frontmatter ${s.frontmatterBytes}B)`),
|
|
});
|
|
}
|
|
}
|
|
for (const key of ["eagerPerInvocation", "perInvocation", "routeCeiling"]) {
|
|
for (const [name, limit] of Object.entries(budget[key] ?? {}) as [string, number][]) {
|
|
const skill = bill.skills.find((s) => s.name === name);
|
|
if (!skill) {
|
|
violations.push({ ceiling: `${key}.${name}`, limit, actual: null, files: ["<skill not found in tree>"] });
|
|
continue;
|
|
}
|
|
const tokens =
|
|
key === "routeCeiling"
|
|
? (skill.routeCeiling?.tokens ?? skill.perInvocationTokens)
|
|
: key === "perInvocation"
|
|
? skill.perInvocationTokens
|
|
: skill.eagerTokens;
|
|
const actual = Math.round(tokens);
|
|
if (actual > limit) {
|
|
violations.push({
|
|
ceiling: `${key}.${name}`,
|
|
limit,
|
|
actual,
|
|
files: [
|
|
`${skill.name}/SKILL.md (${skill.skillMdBytes}B)`,
|
|
...skill.forcedRefs.map((r) => `${skill.name}/${r.path} (${r.bytes}B)`),
|
|
],
|
|
});
|
|
}
|
|
}
|
|
}
|
|
return violations;
|
|
}
|
|
|
|
function fmtBytes(b: number): string {
|
|
if (b >= 1024 * 1024) return `${(b / 1024 / 1024).toFixed(1)}MB`;
|
|
if (b >= 1024) return `${(b / 1024).toFixed(1)}KB`;
|
|
return `${b}B`;
|
|
}
|
|
|
|
/** Exact counts are measurements, so they lose the "~" the estimate wears. */
|
|
function fmtTok(tokens: number, exact: boolean): string {
|
|
const t = Math.round(tokens);
|
|
const tilde = exact ? "" : "~";
|
|
return t >= 1000 ? `${tilde}${(t / 1000).toFixed(1)}K tok` : `${tilde}${t} tok`;
|
|
}
|
|
|
|
export function renderBill(bill: Bill, { skill }: { skill?: string } = {}): string {
|
|
const skills = skill ? bill.skills.filter((s) => s.name === skill) : bill.skills;
|
|
const exact = bill.tokenEstimateErrorPct === 0;
|
|
const size = (bytes: number, tokens: number) => `${fmtBytes(bytes)} (${fmtTok(tokens, exact)})`;
|
|
const lines = [`Context bill for ${bill.root}`, `Token source: ${bill.tokenSource}`, ""];
|
|
|
|
lines.push(
|
|
`ALWAYS-ON (every session): ${skills.length} skills, ` +
|
|
`${size(skills.reduce((n, s) => n + s.frontmatterBytes, 0), skills.reduce((n, s) => n + s.frontmatterTokens, 0))}`,
|
|
);
|
|
// The host wraps each skill's frontmatter in its own available_skills XML
|
|
// element before the model sees it. That wrapper is host-specific and cannot
|
|
// be read from this tree, so it is excluded here — the real always-on cost is
|
|
// this figure plus one wrapper per skill.
|
|
lines.push(" (frontmatter only; excludes the host's per-skill available_skills XML wrapper)");
|
|
for (const s of skills) lines.push(` ${s.name.padEnd(20)} ${size(s.frontmatterBytes, s.frontmatterTokens)}`);
|
|
for (const s of skills) {
|
|
if (s.deadKeys.length) lines.push(` ! ${s.name}: frontmatter key(s) the router never reads: ${s.deadKeys.join(", ")}`);
|
|
for (const f of s.foreignFiles) lines.push(` ! ${s.name}: foreign-host file in scanner scope: ${f.path} (${size(f.bytes, f.tokens)})`);
|
|
}
|
|
lines.push("");
|
|
|
|
lines.push("EAGER (per invocation): SKILL.md + forced-read references");
|
|
for (const s of skills) {
|
|
const refs = s.forcedRefs.length
|
|
? ` = SKILL.md ${fmtBytes(s.skillMdBytes)} + refs ${fmtBytes(sumBytes(s.forcedRefs))} (${s.forcedRefs.map((r) => path.basename(r.path)).join(", ")})`
|
|
: "";
|
|
lines.push(` ${s.name.padEnd(20)} ${size(s.eagerBytes, s.eagerTokens)}${refs}`);
|
|
for (const r of s.forcedRefs.filter((r) => r.missing)) lines.push(` ! ${s.name}: forced-read reference missing on disk: ${r.path}`);
|
|
}
|
|
lines.push("");
|
|
|
|
lines.push(
|
|
`TOTAL on disk: ${size(bill.totals.totalMdBytes, bill.totals.totalMdTokens)} across ${bill.totals.skillCount} skill(s).`,
|
|
);
|
|
lines.push(tokenDisclaimer(bill));
|
|
return lines.join("\n") + "\n";
|
|
}
|
|
|
|
/**
|
|
* Names the error band instead of hand-waving about "estimates". The band is the
|
|
* worst-case residual measured over the calibration corpus, not a guess.
|
|
*/
|
|
export function tokenDisclaimer(bill: Pick<Bill, "tokenEstimateErrorPct" | "tokenSource">): string {
|
|
if (bill.tokenEstimateErrorPct === 0) {
|
|
return `Token counts measured with ${bill.tokenSource}. Bytes are exact.`;
|
|
}
|
|
const per = Object.entries(TOKEN_DIVISORS).map(([k, v]) => `${k} /${v}`).join(", ");
|
|
return (
|
|
`Token counts are ESTIMATES: bytes divided per content class (${per}), calibrated against ` +
|
|
`count_tokens on 219 skill files. Measured accuracy of that estimate: mean ` +
|
|
`per-file error 7.4%, systematic bias under 0.5%, worst single file ` +
|
|
`${bill.tokenEstimateErrorPct}% (dense path/table files). Ledger rows ` +
|
|
`land tighter than single files because errors partly cancel across a sum. Run --exact for ` +
|
|
`measured counts when a number has to be right. Bytes are always exact.`
|
|
);
|
|
}
|
|
|
|
export function renderDiff(diff: { rows: DiffRow[]; grew: boolean }): string {
|
|
if (diff.rows.length === 0) return "No context-cost changes between trees.\n";
|
|
const lines = ["Context-cost changes (sorted by |delta|):", ""];
|
|
for (const r of diff.rows) {
|
|
const sign = r.delta > 0 ? "+" : "-";
|
|
lines.push(
|
|
` ${r.ledger.padEnd(11)} ${r.label.padEnd(28)} ${sign}${fmtBytes(Math.abs(r.delta))} (${sign}${Math.abs(r.tokenDelta)} tok) ${fmtBytes(r.before)} -> ${fmtBytes(r.after)}`,
|
|
);
|
|
}
|
|
lines.push("");
|
|
lines.push(
|
|
diff.grew
|
|
? "RESULT: context cost GREW (always-on or eager)."
|
|
: "RESULT: no always-on or eager growth.",
|
|
);
|
|
return lines.join("\n") + "\n";
|
|
}
|
|
|
|
// --exact defaults to the model the offline divisor was calibrated against, so
|
|
// `--exact` and the estimate are comparable. Later tokenizers differ.
|
|
export const EXACT_DEFAULT_MODEL = "claude-opus-4-5";
|
|
const COUNT_TOKENS_URL = "https://api.anthropic.com/v1/messages/count_tokens";
|
|
const EXACT_CONCURRENCY = 8;
|
|
|
|
/** Typed failures, so callers branch on a code rather than on message text. */
|
|
export class ExactModeError extends Error {
|
|
code: string;
|
|
constructor(code: string, message: string) {
|
|
super(message);
|
|
this.name = "ExactModeError";
|
|
this.code = code;
|
|
}
|
|
}
|
|
|
|
type FetchLike = typeof globalThis.fetch;
|
|
|
|
interface CountTokensOptions {
|
|
model: string;
|
|
apiKey: string;
|
|
fetchImpl: FetchLike;
|
|
}
|
|
|
|
async function countTokens(text: string, { model, apiKey, fetchImpl }: CountTokensOptions): Promise<number> {
|
|
let res: Response;
|
|
try {
|
|
res = await fetchImpl(COUNT_TOKENS_URL, {
|
|
method: "POST",
|
|
headers: {
|
|
"content-type": "application/json",
|
|
"x-api-key": apiKey,
|
|
"anthropic-version": "2023-06-01",
|
|
},
|
|
body: JSON.stringify({ model, messages: [{ role: "user", content: text }] }),
|
|
});
|
|
} catch (error) {
|
|
throw new ExactModeError("exact_network_unreachable", `count_tokens unreachable: ${(error as Error)?.message ?? error}`);
|
|
}
|
|
if (!res.ok) {
|
|
const body = await res.text().catch(() => "");
|
|
const code = res.status === 401 || res.status === 403 ? "exact_auth_rejected" : "exact_request_failed";
|
|
throw new ExactModeError(code, `count_tokens returned ${res.status}: ${body.slice(0, 200)}`);
|
|
}
|
|
const json: any = await res.json();
|
|
if (typeof json?.input_tokens !== "number") {
|
|
throw new ExactModeError("exact_response_malformed", "count_tokens response had no input_tokens");
|
|
}
|
|
return json.input_tokens;
|
|
}
|
|
|
|
export interface ExactMeasurement {
|
|
tokenSource: string;
|
|
tokensOf: TokensOf;
|
|
measuredFiles: number;
|
|
counts: Map<string, number>;
|
|
/** Keys priced by estimate because measurement missed them. Read after buildBill. */
|
|
missedKeys: Set<string>;
|
|
}
|
|
|
|
/**
|
|
* Measures every text the bill will bill for. Returns a `tokensOf` lookup.
|
|
*
|
|
* count_tokens prices a whole request, so it includes a fixed message envelope.
|
|
* That envelope is measured once and subtracted, leaving the tokens each file's
|
|
* own content contributes — otherwise every small reference is overcharged by a
|
|
* constant that has nothing to do with the file.
|
|
*
|
|
* Egress receipt BEFORE any POST (sink 'context-bill-exact'): if the receipt
|
|
* cannot be written this throws exact_egress_receipt_failed, which the CLI
|
|
* degrades to the offline estimate — nothing is sent unrecorded.
|
|
*/
|
|
export async function measureExactTokens(
|
|
root: string,
|
|
{ model, apiKey, fetchImpl = fetch, onProgress, egressHome }: {
|
|
model: string;
|
|
apiKey: string;
|
|
fetchImpl?: FetchLike;
|
|
onProgress?: (done: number, total: number) => void;
|
|
egressHome?: string;
|
|
},
|
|
): Promise<ExactMeasurement> {
|
|
if (!apiKey) {
|
|
throw new ExactModeError(
|
|
"exact_missing_api_key",
|
|
"--exact needs ANTHROPIC_API_KEY. Without it the offline estimate is used; nothing was sent.",
|
|
);
|
|
}
|
|
const opts: CountTokensOptions = { model, apiKey, fetchImpl };
|
|
|
|
const texts = new Map<string, string>();
|
|
// Resolve before keying. buildBill resolves its root, so a relative root here
|
|
// would produce keys that never match and every lookup would fall back to the
|
|
// estimate -- exact mode silently degrading to the thing it replaces.
|
|
for (const file of walkMd(path.resolve(root))) {
|
|
const text = fs.readFileSync(file, "utf8");
|
|
texts.set(file, text);
|
|
if (path.basename(file) === "SKILL.md") {
|
|
const fm = parseFrontmatter(text);
|
|
if (fm.block) texts.set(frontmatterKey(file), fm.block);
|
|
}
|
|
}
|
|
|
|
// Receipt-before-send. Content-free: file count + total bytes only.
|
|
try {
|
|
let totalBytes = 0;
|
|
for (const t of texts.values()) totalBytes += Buffer.byteLength(t, "utf8");
|
|
writeReceipt({
|
|
home: egressHome,
|
|
sink: "context-bill-exact",
|
|
host: "api.anthropic.com",
|
|
payloadClass: `count-tokens skill-tree texts=${texts.size} (${totalBytes}B across ${EXACT_CONCURRENCY}-way POSTs)`,
|
|
bytes: totalBytes,
|
|
sha256: null,
|
|
consent: "user passed --exact",
|
|
});
|
|
} catch (error) {
|
|
throw new ExactModeError(
|
|
"exact_egress_receipt_failed",
|
|
`egress receipt could not be written (${(error as Error)?.message ?? error}); refusing to send unrecorded`,
|
|
);
|
|
}
|
|
|
|
// One-char body: subtracting its single content token leaves the envelope.
|
|
const envelope = (await countTokens("x", opts)) - 1;
|
|
|
|
const counts = new Map<string, number>();
|
|
const keys = [...texts.keys()];
|
|
let next = 0;
|
|
let done = 0;
|
|
const worker = async () => {
|
|
while (next < keys.length) {
|
|
const key = keys[next++];
|
|
const raw = await countTokens(texts.get(key)!, opts);
|
|
counts.set(key, Math.max(0, raw - envelope));
|
|
onProgress?.(++done, keys.length);
|
|
}
|
|
};
|
|
await Promise.all(Array.from({ length: Math.min(EXACT_CONCURRENCY, keys.length) }, worker));
|
|
|
|
// A key the walk never saw (a non-.md foreign-host file) falls back to the
|
|
// estimate rather than billing zero. Misses are counted, not swallowed: a bill
|
|
// that is part-measured and part-estimated must not present itself as measured.
|
|
const missed = new Set<string>();
|
|
const tokensOf: TokensOf = (key, bytes) => {
|
|
const exact = counts.get(key);
|
|
if (exact !== undefined) return exact;
|
|
missed.add(key);
|
|
return estimateTokensOf(key, bytes);
|
|
};
|
|
return {
|
|
tokenSource: `count_tokens (${model})`,
|
|
tokensOf,
|
|
measuredFiles: counts.size,
|
|
counts,
|
|
missedKeys: missed,
|
|
};
|
|
}
|
|
|
|
export interface Calibration {
|
|
rows: {
|
|
path: string;
|
|
contentClass: string;
|
|
bytes: number;
|
|
estimatedTokens: number;
|
|
tokens: number;
|
|
bytesPerToken: number;
|
|
errorPct: number;
|
|
}[];
|
|
worstErrorPct: number;
|
|
meanAbsErrorPct: number;
|
|
biasPct: number;
|
|
}
|
|
|
|
/**
|
|
* Estimate-vs-measured residual per file. This is what makes the divisor
|
|
* auditable: run --exact and the tool grades its own offline estimate.
|
|
*/
|
|
export function calibrationTable(counts: Map<string, number>, root: string): Calibration {
|
|
const rows: Calibration["rows"] = [];
|
|
for (const [key, tokens] of counts) {
|
|
if (key.endsWith("#frontmatter") || tokens === 0) continue;
|
|
const bytes = bytesOf(key);
|
|
if (bytes == null) continue;
|
|
// Grade the estimate the tool actually uses, class divisor included.
|
|
const estimated = Math.round(estimateTokensOf(key, bytes));
|
|
rows.push({
|
|
path: path.relative(root, key),
|
|
contentClass: contentClass(key),
|
|
bytes,
|
|
estimatedTokens: estimated,
|
|
tokens,
|
|
bytesPerToken: Number((bytes / tokens).toFixed(3)),
|
|
errorPct: Number((((estimated - tokens) / tokens) * 100).toFixed(1)),
|
|
});
|
|
}
|
|
rows.sort((a, b) => Math.abs(b.errorPct) - Math.abs(a.errorPct));
|
|
const abs = rows.map((r) => Math.abs(r.errorPct));
|
|
return {
|
|
rows,
|
|
worstErrorPct: abs.length ? Math.max(...abs) : 0,
|
|
meanAbsErrorPct: abs.length ? Number((abs.reduce((a, b) => a + b, 0) / abs.length).toFixed(2)) : 0,
|
|
biasPct: rows.length
|
|
? Number((rows.reduce((n, r) => n + r.errorPct, 0) / rows.length).toFixed(2))
|
|
: 0,
|
|
};
|
|
}
|
|
|
|
// Where installed skills actually live: `.agents/skills` (the host-neutral
|
|
// canonical path) alongside `.claude/skills`, project then user.
|
|
const DEFAULT_TREES: string[][] = [
|
|
["cwd", "skills"],
|
|
["cwd", ".agents", "skills"],
|
|
["cwd", ".claude", "skills"],
|
|
["home", ".agents", "skills"],
|
|
["home", ".claude", "skills"],
|
|
];
|
|
|
|
function defaultTreeCandidates(cwd: string, homeDir: string): string[] {
|
|
return DEFAULT_TREES.map(([base, ...rest]) => path.join(base === "cwd" ? cwd : homeDir, ...rest));
|
|
}
|
|
|
|
function detectDefaultTree(cwd: string, homeDir: string): string | null {
|
|
return defaultTreeCandidates(cwd, homeDir).find((c) => fs.existsSync(c)) ?? null;
|
|
}
|
|
|
|
const USAGE =
|
|
"Usage:\n" +
|
|
" gstack-context-bill [TREE] [--json] [--skill <name>]\n" +
|
|
" gstack-context-bill --diff <treeA> <treeB> [--json]\n" +
|
|
" gstack-context-bill [TREE] --budget <budget.json> [--json]\n" +
|
|
"\n" +
|
|
" --exact measure tokens with Anthropic's count_tokens instead of\n" +
|
|
" estimating. Off by default: it sends the content of every\n" +
|
|
" .md file in the tree to api.anthropic.com. Needs\n" +
|
|
" ANTHROPIC_API_KEY; passing --exact is the consent. An\n" +
|
|
" egress receipt is written before the send (see\n" +
|
|
" gstack-egress); if it cannot be written, the run falls\n" +
|
|
" back to the offline estimate.\n" +
|
|
" --exact also recalibrates: the --json output's\n" +
|
|
" `calibration` block grades the offline divisors\n" +
|
|
" (TOKEN_DIVISORS) file by file against measured counts.\n" +
|
|
" --exact-model <id> model whose tokenizer to count against\n" +
|
|
` (default ${EXACT_DEFAULT_MODEL}, the calibration model).\n`;
|
|
|
|
export interface MainOptions {
|
|
cwd?: string;
|
|
stdout?: { write(s: string): unknown };
|
|
stderr?: { write(s: string): unknown };
|
|
homeDir?: string;
|
|
apiKey?: string;
|
|
fetchImpl?: FetchLike;
|
|
egressHome?: string;
|
|
}
|
|
|
|
export async function contextBillMain(argv: string[], options: MainOptions = {}): Promise<number> {
|
|
const cwd = options.cwd ?? process.cwd();
|
|
const stdout = options.stdout ?? process.stdout;
|
|
const stderr = options.stderr ?? process.stderr;
|
|
const homeDir = options.homeDir ?? os.homedir();
|
|
|
|
const positional: string[] = [];
|
|
const flags: { json: boolean; diff: boolean; exact: boolean; exactModel: string; skill?: string; budget?: string } =
|
|
{ json: false, diff: false, exact: false, exactModel: EXACT_DEFAULT_MODEL };
|
|
for (let i = 0; i < argv.length; i++) {
|
|
const arg = argv[i];
|
|
if (arg === "--json") flags.json = true;
|
|
else if (arg === "--diff") flags.diff = true;
|
|
else if (arg === "--skill") flags.skill = argv[++i];
|
|
else if (arg === "--budget") flags.budget = argv[++i];
|
|
else if (arg === "--exact") flags.exact = true;
|
|
else if (arg === "--exact-model") flags.exactModel = argv[++i];
|
|
else if (arg === "--help" || arg === "-h") {
|
|
stdout.write(USAGE);
|
|
return 0;
|
|
} else if (arg.startsWith("--")) {
|
|
stderr.write(`Unknown flag: ${arg}\n${USAGE}`);
|
|
return 2;
|
|
} else positional.push(arg);
|
|
}
|
|
|
|
// Exact mode is the only path that leaves the machine. Announce what is sent
|
|
// before sending it, and degrade to the estimate rather than failing the run.
|
|
const exactFor = async (tree: string): Promise<{
|
|
tokensOf?: TokensOf;
|
|
tokenSource?: string;
|
|
calibration?: Calibration;
|
|
onDone?: () => void;
|
|
}> => {
|
|
if (!flags.exact) return {};
|
|
const files = walkMd(tree).length;
|
|
stderr.write(
|
|
`--exact: sending the content of ${files} .md file(s) under ${tree} to ` +
|
|
`api.anthropic.com for count_tokens (${flags.exactModel}). No other data leaves this machine.\n`,
|
|
);
|
|
try {
|
|
const measured = await measureExactTokens(tree, {
|
|
model: flags.exactModel,
|
|
apiKey: options.apiKey ?? process.env.ANTHROPIC_API_KEY ?? "",
|
|
fetchImpl: options.fetchImpl,
|
|
egressHome: options.egressHome,
|
|
});
|
|
return {
|
|
tokensOf: measured.tokensOf,
|
|
tokenSource: measured.tokenSource,
|
|
calibration: calibrationTable(measured.counts, tree),
|
|
onDone: () => {
|
|
if (measured.missedKeys.size) {
|
|
stderr.write(
|
|
`--exact: ${measured.missedKeys.size} item(s) had no measurement and were estimated ` +
|
|
`(${[...measured.missedKeys].slice(0, 3).join(", ")}). Those figures are not measurements.\n`,
|
|
);
|
|
}
|
|
},
|
|
};
|
|
} catch (error) {
|
|
if (!(error instanceof ExactModeError)) throw error;
|
|
stderr.write(`--exact unavailable [${error.code}]: ${error.message}\nFalling back to the offline estimate.\n`);
|
|
return {};
|
|
}
|
|
};
|
|
|
|
try {
|
|
if (flags.diff) {
|
|
if (positional.length !== 2) {
|
|
stderr.write(`--diff needs exactly two trees.\n${USAGE}`);
|
|
return 2;
|
|
}
|
|
const treeA = path.resolve(cwd, positional[0]);
|
|
const treeB = path.resolve(cwd, positional[1]);
|
|
const optsA = await exactFor(treeA);
|
|
const optsB = await exactFor(treeB);
|
|
const diff = diffBills(buildBill(treeA, optsA), buildBill(treeB, optsB));
|
|
optsA.onDone?.();
|
|
optsB.onDone?.();
|
|
stdout.write(flags.json ? JSON.stringify(diff, null, 2) + "\n" : renderDiff(diff));
|
|
return diff.grew ? 2 : 0;
|
|
}
|
|
|
|
const tree = positional[0] ? path.resolve(cwd, positional[0]) : detectDefaultTree(cwd, homeDir);
|
|
if (!tree) {
|
|
stderr.write(
|
|
`No skills tree found (tried ${defaultTreeCandidates(cwd, homeDir).join(", ")}). Pass a path.\n`,
|
|
);
|
|
return 2;
|
|
}
|
|
const exactOpts = await exactFor(tree);
|
|
const bill = buildBill(tree, exactOpts);
|
|
exactOpts.onDone?.();
|
|
if (bill.skills.length === 0) {
|
|
stderr.write(`No SKILL.md files found under ${tree}.\n`);
|
|
return 2;
|
|
}
|
|
if (flags.skill && !bill.skills.some((s) => s.name === flags.skill)) {
|
|
stderr.write(`No skill named "${flags.skill}" in ${tree}. Skills: ${bill.skills.map((s) => s.name).join(", ")}\n`);
|
|
return 2;
|
|
}
|
|
|
|
if (flags.budget) {
|
|
const budget = JSON.parse(fs.readFileSync(path.resolve(cwd, flags.budget), "utf8"));
|
|
const violations = checkBudget(bill, budget);
|
|
if (flags.json) {
|
|
stdout.write(JSON.stringify({ ok: violations.length === 0, violations }, null, 2) + "\n");
|
|
} else if (violations.length === 0) {
|
|
stdout.write("Within budget.\n");
|
|
} else {
|
|
for (const v of violations) {
|
|
stdout.write(`OVER BUDGET: ${v.ceiling} at ~${v.actual} tok (ceiling ~${v.limit} tok)\n`);
|
|
for (const f of v.files) stdout.write(` ${f}\n`);
|
|
}
|
|
}
|
|
return violations.length === 0 ? 0 : 2;
|
|
}
|
|
|
|
stdout.write(flags.json ? JSON.stringify(bill, null, 2) + "\n" : renderBill(bill, flags));
|
|
return 0;
|
|
} catch (error) {
|
|
stderr.write(`${(error as Error)?.message ?? error}\n`);
|
|
return 1;
|
|
}
|
|
}
|