Repository navigation
README has no run steps or CLI example (#177) - #194
Closed
Param-Harrison wants to merge 2 commits into
Closed
Param-Harrison wants to merge 2 commits into
Param-Harrison wants to merge 2 commits into
Conversation
Param-Harrison
marked this pull request as ready for review
October 14, 2026 11:33
Contributor
Author
|
Closing as stale: superseded by the current factory runs; the issue stays open to be re-run. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a "Run it" section to README.md covering install, the dev server on http://localhost:3200, and a CLI example. Adds
tests/readme.test.tsto keep the documented commands in line withpackage.jsonandsrc/server.ts.Closes #177
Plan
See the plan comment on #177 (rev 1):
## Run itlistsbun install,bun run devandhttp://localhost:3200, verified bytests/readme.test.ts.bun run src/cli.ts groups, and the README'sbalances <group>/export <group>matchsrc/cli.ts, verified bytests/readme.test.ts.devscript and the default port 3200 match the README, verified bytests/readme.test.ts;bun run src/cli.ts groupswas run during build and printed both demo groups.make check.Left out (non-goals): no changes under
src/,public/,package.json,Makefileorbun.lock; no protected paths orAGENTS.md; existing README sections not rewritten; per-worktree port and database hooks not documented.Gate evidence
FACTORY_GATES: status=GREEN passed=3 failed=0 skipped=1 failed_gates=auditThe audit gate was skipped and is not part of
make check.Verify verdict
See the verdict comment on #177: pass, all four ACs. The two Run it tests fail with README.md reverted (assertion errors, not compile errors) and pass on this branch. One
couldfinding (confidence 3): thebalances <group>andexport <group>assertions check the whole README rather than the Run it section. Not fixed here.Risk and rollback
Low: docs plus a test, no protected path touched, no schema or API change. Roll back by reverting the commit; nothing else depends on it.
Factory run
Proof: the new test fails without the change.
5 stage runs, 3m 10s, $0.94.
Went well
Needed help