Repository navigation
README has no run steps or CLI example (#60) - #73
Open
Param-Harrison wants to merge 2 commits into
Open
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 8, 2026 21:31
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.mdwithbun install,bun run dev(http://localhost:3200) and a CLI example (bun run src/cli.ts groups), plustests/readme.test.tsso the documented commands stay true to the repo.Closes #60
Plan
Plan comment (
.factory/runs/issue-60/plan-comment.md, rev 1):## Run itsection withbun install, verified bybun test tests/readme.test.tsbun run devandhttp://localhost:3200matchpackage.jsonand thesrc/server.tsdefault port, verified bybun test tests/readme.test.tsbun run src/cli.ts groupsruns against a seeded in-memory DB, verified bybun test tests/readme.test.tsmake checkNon-goals: no changes under
src/,public/,package.json,bun.lockorMakefile; no protected paths,AGENTS.mdorDEMO.md; no rewrite of existing README sections.Gate evidence
FACTORY_GATES: status=GREEN passed=3 failed=0 skipped=1 failed_gates=auditVerify verdict
Verdict: pass (verdict comment,
.factory/runs/issue-60/verdict-comment.md). All four ACs pass. The new tests fail withREADME.mdrestored frommain(0 pass, 3 fail) and pass on this branch (3 pass, 0 fail). Two non-blocking "could" findings: the port check greps thesrc/server.tssource, and only thegroupscommand is executed by the test.Risk and rollback
low: docs plus a new test file, with no schema, API or protected-path change. Roll back by reverting the commit; nothing else depends on it.
Factory run
5 stage runs, 3m 32s, $1.21.
Went well
Needed help