Skip to content
Indigo HQ Docs

hq-cli

hq-cli ships the hq command — the ongoing management CLI for an HQ instance. It is published to npm as @indigoai-us/hq-cli (currently 5.x).

What it is

  • The operator-facing CLI: “HQ by Indigo management CLI — modules and cloud sync.”
  • Provides the hq binary (plus an hq-auth-refresh helper).
  • Built on Node ≥22, ESM + TypeScript, Commander 12. Depends on @indigoai-us/hq-cloud for sync.

The public seed-mirror may show an early placeholder version (e.g. 0.1.0). The current, canonical CLI is @indigoai-us/hq-cli 5.x — that’s the one to install.

Who uses it / when

Everyone operating an HQ instance from the terminal. After hq-core scaffolds the directory, the hq CLI is how you manage modules and drive cloud sync day to day.

Key commands

Terminal window
# module management
hq modules list             # show module inventory
hq modules add <repo-url>   # clone + register a module
hq modules sync             # update all modules to pinned commits


# cloud sync (delegates to @indigoai-us/hq-cloud)
hq sync init                # authenticate
hq sync start               # start background sync
hq sync status              # health
hq sync stop                # stop background sync


# packs (content packs)
hq install @indigoai-us/hq-pack-<name>   # install a content pack
hq packs list                            # installed packs + the curated catalog
hq packs update [name]                   # re-install the latest (--check-only to peek)
hq packs uninstall <name>                # un-wire + archive a pack cleanly


# capabilities
hq run / hq secrets exec                 # schema-driven secret access

Pack commands accept --json for machine-readable output — the hq-sync menubar app uses this to power its Packages window.

How it composes

hq-cli handles two concerns: module management (the module system) and cloud sync. Sync subcommands lazily import("@indigoai-us/hq-cloud") only when invoked, so module commands work even without the cloud engine present. The same engine is also driven by the hq-sync menubar app.