Skip to content

README has no run steps or CLI example (#159) - #166

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

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

Conversation

@Param-Harrison

Copy link
Copy Markdown
Contributor

Summary

Add a "Run it" section to README.md with the install, dev-server and CLI steps, each working as written on a clean clone.

Closes #159

Plan

Plan comment (rev 1) on the issue thread:

  • AC-1 ## Run it lists bun install, verified by bun test tests/readme.test.ts
  • AC-2 bun run dev and http://localhost:3200 (matches PORT ?? 3200 in src/server.ts), verified by bun test tests/readme.test.ts
  • AC-3 CLI example bun run src/cli.ts groups, verified by bun test tests/readme.test.ts
  • AC-4 the CLI example runs: exit 0 and goa-trip in stdout with SPLITBILL_DB=:memory:, verified by bun test tests/readme.test.ts
  • AC-5 full gate green, verified by make check

Non-goals kept: no changes under src/, package.json, Makefile, bun.lock, protected paths or AGENTS.md; existing README sections not rewritten.

Gate evidence

FACTORY_GATES: status=GREEN passed=3 failed=0 skipped=1 failed_gates=audit

(The non-required audit gate was skipped, not failed.)

Verify verdict

Verdict comment on the issue thread: pass, AC-1 to AC-5 all pass, no reviewer findings. The section tests fail on the base branch with an assertion failure (no ## Run it heading, Expected: >= 0, Received: -1) and pass here (4 pass, 0 fail). The CLI-run test checks existing behaviour, so it also passes on base.

Risk and rollback

Low: docs-only plus one new test file, no protected path, no API or schema change. Roll back by reverting this PR; nothing else depends on it.

Factory run

Stage Agent Duration Tool calls Cost Outcome
triage claude 14s 5 $0.06 ok
plan claude 30s 5 $0.26 ok
build claude 1m 33s 14 $0.29 ok
verify claude 52s 15 $0.28 pass
pr claude 15s 4 $0.08 ok

5 stage runs, 3m 24s, $0.97.

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 8, 2026 21:50
@Param-Harrison
Param-Harrison deleted the factory/issue-159 branch October 8, 2026 22:06
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