Global flags
gitq parses its own command line in one place, src/cli/main.ts, with node's parseArgs, in non-strict mode. This page is the complete list of what it recognizes, which commands read what, and what non-strict mode actually does with a flag you typo.
Exit codes and errors
gitq uses exactly three exit codes, and the code is the only signal a script or an agent driving gitq should rely on. Branch on the exit code, not on human text, and read the JSON's own fields for anything more granular than "did this work".
JSON output
Every command accepts --json (see Global flags) and prints one JSON document to stdout instead of its human summary, through a single shared function, emit() (src/cli/output.ts:4-7). The shapes on this page come from the actual value each command passes to emit(), read at the source, not from a written schema. Most are real captures against a scratch repo, trimmed for length where the real output is long; a few, noted as such, are described from the source type they are built from rather than a live run, because reaching that exact state (a real publish, a specific per branch failure) either needs a real forge API, which this task did not touch, or a lengthy setup for a shape already fully specified in source.
Configuration
gitq has two independent local configuration surfaces, read by two different processes, plus a shared settings store that can override individual keys of either. The CLI reads a settings file inside its own config directory. The board reads a config.json sitting in the app root. Neither reads the other's file, and nothing in the CLI reads anything from the board's config.json. The rt settings store sits above both: when it owns a key (or, for gitq.workSlots, a field of one), that value wins over whichever file would otherwise have answered.
Pause file
gitq-pause.json is what a cascade writes the instant it stops on a conflict. This page is its full schema, field by field, from the types that define it, plus a real capture straight off disk. For the protocol around it, the resolve loop, what refuses, what continue and abort each do, see The pause protocol; this page only covers the file itself.
Read only
4 items
Tracking
4 items
Cascade
3 items
Surgery
6 items
Forge
3 items
Other
1 item