docs(docs): add the Piwi CLI reference page - #475
Merged
Conversation
Phase-2 documentation restructure — another additive "new page". The `piwi` CLI has six subcommands and no page of its own: init lived on getting-started and mcp, gate on ci (a subset of its flags), select/run on test-selection, ai on ai-steps, skills on mcp. A power user wanting "every flag of gate" had nowhere to go. Add apps/docs/cli.md, a reference documenting every subcommand and flag, transcribed from each command's own --help in packages/reporter/src/cli/ so it can't drift from behavior: - init, skills, gate, select/run, ai — each with usage, a full flag table, the connection env-var fallbacks (PIWI_DASHBOARD_URL / PIWI_API_KEY / PIWI_PROJECT_NAME) and, where they matter for CI, the exit codes. - Cross-links to the feature pages that tell the story (getting-started, ci, test-selection, ai-steps, mcp#agent-skills). Adds a "Piwi CLI" entry to the "Apps & integrations" sidebar group. Purely additive — no existing page URL or anchor changes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GKdmqq1BRUPeH5BxSPV5Jj
Contributor
Coverage Report for Reporter (./packages/reporter)
File CoverageNo changed files found. |
Contributor
Coverage Report for Application (./apps/application)
File CoverageNo changed files found. |
3 tasks
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
2 participants
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.
What & why
Phase-2 restructure — another additive new page (rebased onto current
main, which now carries phase 1 + the Branches page).The
piwiCLI has six subcommands and no page of its own. Its flags were scattered and partial:initon getting-started + mcp,gateon ci (only some of its flags),select/runon test-selection,aion ai-steps,skillson mcp. A power user wanting "every flag ofgate" had nowhere to go.Adds
apps/docs/cli.md, a reference documenting every subcommand and flag, transcribed from each command's own--helpinpackages/reporter/src/cli/(with the default constants resolved from source) so it can't drift from behavior:init,skills,gate,select/run,ai— each with usage, a full flag table, the connection env-var fallbacks (PIWI_DASHBOARD_URL/PIWI_API_KEY/PIWI_PROJECT_NAME), and the exit codes where they matter for CI.Adds a "Piwi CLI" entry to the "Apps & integrations" sidebar group. Purely additive — no existing page URL or anchor changes, no stubs, no in-app link updates.
How was it tested?
npm run docs:build— green; the dead-link check validates every anchor (it caught one wrong anchor I'd written —ci#the-run-url-in-ci→ corrected toci#getting-the-run-url-back-out-of-ci).npx vitest run tests/unit/docs-drift.test.ts— 124 passing.Checklist
type(scope): subject)🤖 Generated with Claude Code
https://claude.ai/code/session_01GKdmqq1BRUPeH5BxSPV5Jj
Generated by Claude Code