ghqc CLI
The ghqc CLI exposes the same QC lifecycle as the web UI, but in a prompt-driven or scriptable terminal workflow.
Most commands have both interactive and non-interactive modes.
Commands
Section titled “Commands”Authentication
Section titled “Authentication”Commands for logging in, inspecting auth source resolution, and retrieving the token ghqc will actually use.
ghqc auth login- Log in for the current repository host or a specific GitHub host.ghqc auth logout- Remove a token stored in the localghqcauth store.ghqc auth status- Show the local auth store and the auth sources available for the selected host.ghqc auth token- Print the resolved token using the normal auth priority order.
Issue Management
Section titled “Issue Management”Commands for issue management from creation, to iteration, to approval.
ghqc issue create- Create a new QC issue for a file by creating or selecting a milestone.ghqc issue comment- Notify the reviewer about changes made between commits by posting a QC notification comment.ghqc issue review- Review the current working directory against a tracked commit and post reviewer feedback.ghqc issue approve- Approve a QC issue at a selected commit and close it.ghqc issue unapprove- Reopen an approved QC issue when additional changes are needed.ghqc issue status- Print detailed QC, git, checklist, and dependency status for a single issue.
Milestone Management
Section titled “Milestone Management”Commands for summarizing, exporting, and archiving groups of QC issues.
ghqc milestone status- Print a table of issue status across one or more milestones.ghqc milestone record- Generate a PDF QC record for selected milestones.ghqc milestone archive- Bundle milestone artifacts into an archive for storage or delivery.
Configuration Management
Section titled “Configuration Management”Commands for cloning, inspecting, and verifying the shared configuration used by ghqc.
ghqc configuration setup- Clone the configuration repository into the resolved local config directory.ghqc configuration status- Print the resolved config directory, git state, and loaded checklist summary.
Diagnostics
Section titled “Diagnostics”Commands for capturing the current CLI, repository, and configuration environment.
ghqc sitrep- Print a combined situation report for the binary, project repository, and configuration.
Server and Web UI
Section titled “Server and Web UI”Commands for running ghqc as a local API service or embedded browser app.
ghqc serve- Start the REST API server without the embedded UI.ghqc ui- Start the embedded web UI and API server together, or print the resolved UI URL.
Global Options
Section titled “Global Options”These options can be used with most ghqc commands.
| Flag | Description |
|---|---|
-d, --directory | Set the git project directory that ghqc should operate on. Defaults to the current working directory, .. |
--config-dir | Override the resolved configuration directory. By default, ghqc resolves this automatically from the configured repository location. |