Skip to content

README has no run steps or CLI example (#177) - #194

Closed
Param-Harrison wants to merge 2 commits into
mainfrom
factory/issue-177
Closed

Param-Harrison wants to merge 2 commits into
mainfrom
factory/issue-177

Conversation

@Param-Harrison

Copy link
Copy Markdown
Contributor

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.ts to keep the documented commands in line with package.json and src/server.ts.

Closes #177

Plan

See the plan comment on #177 (rev 1):

  • AC-1: ## Run it lists bun install, bun run dev and http://localhost:3200, verified by tests/readme.test.ts.
  • AC-2: the section includes bun run src/cli.ts groups, and the README's balances <group> / export <group> match src/cli.ts, verified by tests/readme.test.ts.
  • AC-3: dev script and the default port 3200 match the README, verified by tests/readme.test.ts; bun run src/cli.ts groups was run during build and printed both demo groups.
  • AC-4: full suite passes, verified by make check.

Left out (non-goals): no changes under src/, public/, package.json, Makefile or bun.lock; no protected paths or AGENTS.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=audit

The 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 could finding (confidence 3): the balances <group> and export <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

Stage Agent Duration Tool calls Cost Outcome
triage claude 14s 6 $0.06 ok
plan claude 25s 5 $0.18 ok
build claude 1m 22s 16 $0.31 ok
verify claude 54s 11 $0.33 pass
pr claude 14s 3 $0.07 ok

Proof: the new test fails without the change.

5 stage runs, 3m 10s, $0.94.

Went well

  • triage, plan, build, verify, pr passed on the first attempt
  • verify approved on the first round

Needed help

  • nothing

@Param-Harrison
Param-Harrison marked this pull request as ready for review October 14, 2026 11:33
@Param-Harrison

Copy link
Copy Markdown
Contributor Author

Closing as stale: superseded by the current factory runs; the issue stays open to be re-run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README has no run steps or CLI example

1 participant