CLI Reference
The Terrantula CLI (terrantula) is the primary interface for importing Terraform and Atmos state, running the local dashboard, and managing your project configuration.
Global Options
These options apply to all commands:
| Flag | Description |
|---|---|
--base-url <url> | API base URL (overrides config) |
--token <token> | API token (overrides config) |
--org <id> | Org ID (slug) for org/project-scoped commands (overrides config) |
--project <id> | Project ID for project-scoped commands (overrides config) |
--json | Output raw JSON (default: pretty JSON) |
Commands
| Command | Description |
|---|---|
login | Save API credentials — token to the OS keyring, base URL to the config file (token comes from --token or TERRANTULA_TOKEN) |
use | Set the default project for project-scoped commands |
import | Import data from external sources |
import-terraform | Import Terraform state (alias for import terraform) |
onboard | Zero-config on-ramp: read Terraform, infer the catalog, apply it, and wait for the graph. A directory is read as a Terraform checkout and/or a tree of state files; a file or an s3://|tfc:// URI is read as one state. |
sync | Re-read Terraform state, re-record observations, and report what the evaluation changed |
import-atmos | Import Atmos stack manifests into Terrantula as entities |
convert | Convert legacy configuration into catalog declarations |
spin | Spin up a fleet control plane from a blueprint: create a local project, apply its catalog, then deliver the skeleton IaC — scaffolded locally, or as a ready-to-merge PR into a target repo via --pr-into (your CI applies — Terrantula never runs terraform apply) |
dashboard | Open the local Terrantula dashboard in your browser |
export | Dump the project catalog (schema + entities + relationships) as apply-shaped YAML |
orgs | Manage orgs |
projects | Manage projects |
github | Manage github |
blueprints | Manage blueprints |
entities | Manage entities |
membership | Manage membership |
placement | Manage placement |
relationships | Manage relationships |
actions | Manage actions |
action-runs | Manage action-runs |
secrets | Manage secrets |
apply | apply |
observations | Manage observations |
reconcile | Manage reconcile |
discovery | Manage discovery |
catalog | Manage catalog |
catalog-revisions | Manage catalog-revisions |
audit-events | Manage audit-events |
drift-events | Manage drift-events |
conformance-findings | Manage conformance-findings |
stats | Manage stats |
graph-views | Manage graph-views |
notifications | Manage notifications |
audit-export | Manage audit-export |
user-preferences | Manage user-preferences |
import-sources | Manage import-sources |
resolve-source | resolve-source |
export-catalog | Export every catalog kind as a single apply-shaped payload |
admin | Manage admin |
project | Project-level commands |
ON THIS PAGE