Skip to content

ph bandum ​

Tasks and acceptance testing: start, pr, review, test, verify, fix, pull, board

This page is generated from ph bandum --help by npm run gen in site/, so do not edit it by hand.

text
Usage: ph bandum <command>

Commands ​

login ​

text
login [--token-stdin]                 Same as ph connect github: stores your GitHub token in this machine's secret store

start ​

text
start <KEY> [--no-scaffold]           Pick up a task: assign it to me, set "in progress", create branch feature/<KEY>-<title>,
                                      create the testcases.md skeleton in the right place (not committed; --no-scaffold skips it)
                                      KEY is GH-n for GitHub/GitLab issues, or a Jira key (PAY-12) when the project's task source is Jira

paths ​

text
paths [KEY] [--json] [--offline]      Locations of the task's test files (testcases, acceptance, evidence, spec, .bandum.json) and
                                      the AC list; an API for hooks and agents to write in the right place

pr ​

text
pr <KEY>                              Open a PR from the current (pushed) branch to the main branch; the description has "Closes #n"
                                      (GitHub/GitLab issue) or "Jira: <link>" and the title has [PAY-12] (Jira task)

check ​

text
check [KEY] [--offline] [--junit <file>] [--json]
                                      Check testcases.md, acceptance.md and .bandum.json in the working directory before you
                                      commit (format, duplicate IDs, ACs without test cases…); KEY defaults to the branch name;
                                      exits 0 with no errors, 2 with errors; --json for agents and CI

review ​

text
review <KEY>                          Hand off for testing: check the PR and test cases (every AC has a test case), status "review"
                                      (Jira: the ACs are read from the issue description, then the issue is moved to the review status)

test ​

text
test <KEY> [--yes] [--no-open]       Manual testing: fetch the PR branch into a worktree, run the app (.bandum.json), open the app and
                                      the task page on the Bandum web to grade and click Approve / Send back; stops the app when done

test (2) ​

text
test <KEY> --cli | --pass TC-1,TC-2 [--fail "TC-3=reason"] [--note …] [--evidence <file>…]
                                      Grade in the terminal or with flags: writes acceptance.md, commits and pushes to the PR branch,
                                      reviews the PR, status approved/rejected (Jira: then the issue is moved and a summary comment
                                      is added; if Jira fails the results are kept and ph bandum sync-status KEY tries again)

verify ​

text
verify <KEY> [--yes] [--quiet]        Automated testing: fetch the PR branch into a worktree, run setup/run/test from .bandum.json,
                                      read JUnit results by TC ID, write acceptance.md, status approved/rejected
                                      (exits 0 when approved, 2 when sent back)

sync-status ​

text
sync-status <KEY>                     Jira tasks: write the latest test run to Jira again (move to approved/rejected, summary comment);
                                      safe to repeat: nothing happens when Jira already shows the result

fix ​

text
fix <KEY> [--print] [-- <claude args>]
                                      Task sent back: status in progress, check out the PR branch, hand it to an agent (Claude Code
                                      through phillip) to fix from the comments, test cases and ACs; the agent commits, then Phillip pushes

pull ​

text
pull <KEY>                            Comments from the latest test run (failed TCs, ACs, notes) so you can fix them

board ​

text
board [--milestone <name> | --sprint <name>] [--mine] [--json]
                                      Sprint (milestone) tasks by status (Jira: tasks and sprints are read from Jira). --mine shows my inbox instead: tasks waiting for me to test,
                                      tasks I sent back that came back with new commits, my tasks that were sent back (with --json:
                                      my assigned tasks plus "inbox")

bug ​

text
bug "<title>" [--from GH-n] [--tc TC-x] [--severity high|medium|low] [--steps …] [--expected …] [--actual …]
    [--body-file f.md] [--evidence <file>]… [--source agent|human] [--queue]
                                      Report a bug OUTSIDE the task's scope: creates a new issue (type: bug), or comments if it is a duplicate;
                                      masks secrets before sending; when offline, saves it to the queue in .bandum/bugs/

bug list ​

text
bug list | bug push                   Show the local queue | send the queue

labels init ​

text
labels init [--repo owner/name]       Create the standard labels (status: …, type: …, level: …, with color and description) on a repo; safe to run again

release list|show|approve|status|retry ​

text
release list|show|approve|status|retry <milestone> [--version 1.4.0] [--notes-file note.md] [--yes] [--json]
                                      Release candidates per milestone: see the proposed version and release notes, approve with your own account
                                      (writes docs/releases/<version>.md, runs the release workflow), follow it, run it again after a failure

ui ​

text
ui [--docker] [--port n] [--repo o/r]… [--no-open] [--version v]
                                      Download, configure and run Bandum locally (SQLite by default; --docker: PostgreSQL), open the web app

ui stop ​

text
ui stop | status | logs [-f] | reset [--yes] | upgrade
                                      Stop | list instances | logs | delete local data | upgrade the binary
text
Task source: the project bound to this folder (ph project use) tells whether tasks are GitHub/GitLab issues or Jira tasks;
Jira tasks use your own Jira token (ph connect jira) and the PR is found by key in the branch name or title.
Repo: the origin remote of the current directory (set PHILLIP_GITHUB_REPO=owner/repo to override).
Bandum web: PHILLIP_BANDUM_URL (default http://localhost:8070).