docs: CLI how-to guide and command reference (Diataxis docs)#3844
docs: CLI how-to guide and command reference (Diataxis docs)#3844mabry1985 wants to merge 5 commits into
Conversation
Add .claude/skills/protomaker-cli.md so agents use the CLI (via Bash + --help discovery) as the primary board interface instead of MCP tools. Documents the full command surface and a feature->PR loop workflow. Co-authored-by: Automaker <automaker@localhost> Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
Adds the `br` binary (Dicklesworthstone/beads_rust v0.2.11) alongside `gh` in the server runtime stage. SHA256-pinned, multi-arch (amd64 + arm64). Lets agents running inside the protoMaker server container read/write the `.beads/` issue-tracker store mounted from the host repo. Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
…ds (#3836) Follow-up to #3835. The `beads_rust` v0.2.11 amd64 binary is dynamically linked against GLIBC 2.38/2.39, but `node:22-slim` is Debian Bookworm (glibc 2.36) — running `br --version` in the built image fails with: br: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.38' not found br: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.39' not found `node:22-trixie-slim` ships glibc 2.41, which satisfies both. Trixie is Debian's current stable. All apt packages we install (gh, gosu, Playwright/Chromium deps, etc.) exist in Trixie. Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Add a how-to walkthrough for driving the board from the CLI and a comprehensive reference covering all command groups and flags. Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
|
👀 Quinn is reviewing — verdict (PASS / WARN / FAIL) + findings to follow. |
|
Warning Review limit reached
More reviews will be available in 8 minutes and 26 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![protoquinn[bot]](https://avatars.githubusercontent.com/in/3282126?s=60&v=4){kind=small}
There was a problem hiding this comment.
QA Audit — PR #3844 | docs: CLI how-to guide and command reference (Diataxis docs)
VERDICT: PASS
CI Status
build: ✅ successdeploy: ✅ successtest: in_progressci-complete/checks: queuedClose external code contributions: skipped (author is not external)
Diff Review
This PR recovers committed work stranded by a git-workflow bug and adds the Diataxis documentation layer for the board system:
.claude/skills/protomaker-cli.md(new, 200 lines) — agent-facing skill card documenting all command groups, discovery patterns, the full feature→PR loop, and JSON mode for scripting. Correct file location and valid frontmatter.docs/how-to/drive-the-board.md(new) — step-by-step how-to covering health → board view → create → dispatch → PR → merge → auto-mode → sitrep → JSON scripting. Matches the Diataxis how-to template.docs/reference/cli-commands.md(new) — complete reference for all 10 command groups with flags, defaults, and enum values. Well-structured table format.- TOC and index links updated accordingly.
No source code changes; no tests required for documentation PRs.
Observations
- LOW: CI pipeline is still running (
testin_progress,ci-completequeued). Build and deploy already green — no signals to block on. - INFO: The pipeline note is acknowledged as a separate tracking item. This review is scoped to the PR content only.
- INFO: No unresolved CodeRabbit threads.
— Quinn, QA Engineer
|
Submitted |
1 participant
Completes the Diataxis docs feature (Agent integration & docs epic). The agent had committed this work in its worktree but no PR was created (the git-workflow saw a clean tree after the agent self-committed — see note below), so recovering it manually.
Adds
docs/how-to/drive-the-board.md— step-by-step: health check → board view → create feature → dispatch → PR → merge → auto-mode → sitrep → JSON scriptingdocs/reference/cli-commands.md— complete reference for all 10 command groups (board, query, health, sitrep, feature, agent, pr, queue, auto-mode, context) with flags, defaults, enumsPipeline note
This surfaced a bug: when the execution agent commits its own work, the local review's
git diff --cachedfinds nothing staged ("no diff to review") and the git-workflow creates no PR ("no PR evidence"), stranding committed work in the worktree. Filing separately.🤖 Generated with Claude Code