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) |
--env <name> | Environment name for env-scoped commands (overrides config; defaults to "default") |
--json | Output raw JSON (default: pretty JSON) |
Commands
| Command | Description |
|---|---|
login | Save API credentials to local config (token comes from --token or TERRANTULA_TOKEN) |
use | Set the default project for project-scoped commands |
import | Import data from external sources |
import-atmos | Import Atmos stack manifests into Terrantula as entities |
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 |
environments | Manage environments |
entity-types | Manage entity-types |
entities | Manage entities |
cells | Manage cells |
relationship-types | Manage relationship-types |
relationships | Manage relationships |
actions | Manage actions |
action-runs | Manage action-runs |
secrets | Manage secrets |
apply | Apply schema + data declarations against the project (terraform-style) |
catalog-revisions | Manage catalog-revisions |
audit-events | Manage audit-events |
drift-events | Manage drift-events |
stats | Manage stats |
graph-views | Manage graph-views |
notifications | Manage notifications |
audit-export | Manage audit-export |
import-sources | Manage import-sources |
export-catalog | Export every catalog kind as a single apply-shaped payload |
admin | Manage admin |
project | Project-level commands |
ON THIS PAGE