Skip to main content

CLI commands

Command names and flags evolve — treat grid --help and the grid-cli README as authoritative. This page documents the operator intent of each family.

Discovery​

IntentTypical command
List providers / maturitygrid providers
Scan a desired-state treegrid status --config-dir <root>

Generate​

Produces Terraform for one unit JSON into an output directory (or archive layout when integrated with Core).

Requires module bank access (GRID_MODULE_BANK / ref) and a valid unit document.

Plan / deploy / destroy​

Thin orchestration over Terraform after generate:

IntentNotes
PlanNo apply; use for PR checks and console Plan releases
DeployApply with optional --auto-approve
DestroyTear down the unit root

Prune​

Used when cleaning inventory / optional destroy workflows. Prefer explicit confirmation; Grid Sync alone never destroys.

Environment​

When Core spawns the CLI it sets config root, module bank, terraform binary, and TF backend variables. Local runs should export the same GRID_* / cloud credentials you expect in production.