run
Symbol Details
cli_command: run_apply_cmd
- source
Since: 0.6.0
def run_apply_cmd(*, auto_approve: bool = False, var_file: Path | None = None, init_mode: InitMode = <InitMode.AUTO: 'auto'>) -> None:
...
Run apply across multiple run directories.
CLI Options:
| Flag | Type | Default | Env Var | Description |
|---|---|---|---|---|
--auto-approve |
bool |
False |
- | Skip interactive approval prompts |
--var-file, -f |
Path | None |
None |
- | Path to a terraform .tfvars file |
--init-mode, -I |
InitMode |
<InitMode.AUTO: 'auto'> |
TFDO_INIT_MODE |
Init behavior: auto (run init on error related to init), always (run init first), never (skip init) [auto, always, never] |
Changes
| Version | Change |
|---|---|
| 0.6.0 | Made public |
cli_command: run_callback
- source
Since: 0.6.0
def run_callback(*, env: str | None = None, app_name: str | None = None, team: str | None = None, tags: list[str] = [], changed: bool = False, parallel: int = 10, on_failure: FailureMode = <FailureMode.STOP: 'stop'>, dry_run: bool = False) -> None:
...
CLI Options:
| Flag | Type | Default | Description |
|---|---|---|---|
--env |
str | None |
None |
Filter run directories by {env} selector from discovery pattern |
--app |
str | None |
None |
Filter run directories by {app} selector from discovery pattern |
--team |
str | None |
None |
Filter by team: uses {team} selector if in discovery pattern, otherwise falls back to tags.team |
--tags |
list[str] |
[] |
Tag filter as key=value, repeatable with AND logic (e.g. --tags env=dev --tags team=infra) |
--changed |
bool |
False |
Limit to run directories affected by git diff vs HEAD |
--parallel |
int |
10 |
Max concurrent run directory executions per wave |
--on-failure |
FailureMode |
<FailureMode.STOP: 'stop'> |
Failure behavior: stop aborts remaining directories, continue runs all [stop, continue] |
--dry-run |
bool |
False |
Show execution plan (waves and run directories) without running terraform |
Changes
| Version | Change |
|---|---|
| 0.6.0 | Made public |
cli_command: run_destroy_cmd
- source
Since: 0.6.0
def run_destroy_cmd(*, auto_approve: bool = False, var_file: Path | None = None, init_mode: InitMode = <InitMode.AUTO: 'auto'>) -> None:
...
Run destroy across multiple run directories.
CLI Options:
| Flag | Type | Default | Env Var | Description |
|---|---|---|---|---|
--auto-approve |
bool |
False |
- | Skip interactive approval prompts |
--var-file, -f |
Path | None |
None |
- | Path to a terraform .tfvars file |
--init-mode, -I |
InitMode |
<InitMode.AUTO: 'auto'> |
TFDO_INIT_MODE |
Init behavior: auto (run init on error related to init), always (run init first), never (skip init) [auto, always, never] |
Changes
| Version | Change |
|---|---|
| 0.6.0 | Made public |
cli_command: run_init_cmd
- source
Since: 0.6.0
Run init across multiple run directories.
CLI Options:
| Flag | Type | Default | Description |
|---|---|---|---|
--reconfigure |
bool |
False |
Pass -reconfigure to terraform init |
--extra-args |
list[str] | None |
None |
Extra arguments forwarded to terraform init (e.g. --extra-args=-upgrade) |
Changes
| Version | Change |
|---|---|
| 0.6.0 | Made public |
cli_command: run_plan_cmd
- source
Since: 0.6.0
def run_plan_cmd(*, var_file: Path | None = None, init_mode: InitMode = <InitMode.AUTO: 'auto'>, out: Path | None = None, json_output: bool = False) -> None:
...
Run plan across multiple run directories.
CLI Options:
| Flag | Type | Default | Env Var | Description |
|---|---|---|---|---|
--var-file, -f |
Path | None |
None |
- | Path to a terraform .tfvars file |
--init-mode, -I |
InitMode |
<InitMode.AUTO: 'auto'> |
TFDO_INIT_MODE |
Init behavior: auto (run init on error related to init), always (run init first), never (skip init) [auto, always, never] |
-o, --out |
Path | None |
None |
- | Write plan output to file (per run directory) |
--json |
bool |
False |
- | Output in JSON format |
Changes
| Version | Change |
|---|---|
| 0.6.0 | Made public |