Skip to content
ghqc

Configuration Status

ghqc configuration status prints a focused configuration report for the currently resolved config directory. It is the CLI counterpart to the UI’s Configuration tab and a narrower alternative to ghqc sitrep.

Terminal window
ghqc configuration status

Status loads configuration from the resolved directory and reports:

  • the resolved local configuration directory
  • Git repository owner/repo when the directory is a Git clone
  • git status details, including dirty files when present
  • the configured checklist directory and the number of loaded checklists
  • the active repository options currently applied from options.yaml and defaults
  • whether the configured logo file exists
  • a checklist-by-checklist item count summary

ghqc configuration status does not have an interactive mode. Run it directly, or add --config-dir to inspect a specific configuration directory.

Terminal window
ghqc configuration status
Terminal window
ghqc configuration status --config-dir /path/to/config
FlagDescription
--config-dirOverride the configuration directory to inspect.
  • Status uses the same configuration-directory resolution order as the rest of ghqc
  • If options.yaml is missing or cannot be parsed, ghqc falls back to built-in defaults instead of aborting
  • The built-in Custom checklist is always present, even if the configured checklist directory is missing
  • If the directory is not a Git repository, status still prints configuration details but omits Git repo metadata
  • If a custom logo_path is configured but the file is missing, status prints a warning
  • The options section includes the resolved values for display name, collaborator policy, checklist directory, record path, refresh rate, and optional checklist note
== Directory Information ==
📁 directory: /Users/you/.local/share/ghqc/ghqc-config.git
📦 git repository: org/ghqc-config
Repository is up to date!
⚙️ active options:
- display name: checklists
- include collaborators: yes
- checklist directory: checklists
- record path: record.typ
- ui refresh rate: 15s
📋 Checklists available in 'checklists': 4
✅ Logo found at logo.png
== Checklists Summary ==
📌 checklist note:
│ Note: edit checklist items as needed
- Code Review: 10 checklist items
- Custom: 1 checklist items
- General Script: 3 checklist items
- Report: 7 checklist items