Skip to content
ghqc

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 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 local ghqc auth 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.

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.

Commands for summarizing, exporting, and archiving groups of QC issues.

Commands for cloning, inspecting, and verifying the shared configuration used by ghqc.

Commands for capturing the current CLI, repository, and configuration environment.

  • ghqc sitrep - Print a combined situation report for the binary, project repository, and configuration.

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.

These options can be used with most ghqc commands.

FlagDescription
-d, --directorySet the git project directory that ghqc should operate on. Defaults to the current working directory, ..
--config-dirOverride the resolved configuration directory. By default, ghqc resolves this automatically from the configured repository location.