core

• InitMode
• apply_cmd
• check_cmd
• destroy_cmd
• init_cmd
• plan_cmd

Symbol Details

cli_command: apply_cmd

• source

  Since: 0.1.0

def apply_cmd(*, auto_approve: bool = False, var_file: Path | None = None, init_mode: InitMode = <InitMode.AUTO: 'auto'>) -> None:
    ...

Run terraform apply.

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.1.0	Made public

cli_command: check_cmd

• source

  Since: 0.1.0

def check_cmd(*, fix: bool = False, diff: bool = False, init_mode: InitMode = <InitMode.AUTO: 'auto'>, include: list[str] = [], exclude: list[str] = [], tflint: bool | None = None, skip_check_providers: bool | None = None) -> None:
    ...

Run terraform fmt check + validate (ruff-style).

CLI Options:

Flag	Type	Default	Env Var	Description
--fix	bool	False	-	Apply fixes: terraform fmt, backend/provider drift in HCL; when interactive, prompt for missing terraform.tfvars.
--diff	bool	False	-	Show what would change
--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]
--include	list[str]	[]	-	Glob patterns: only matching directories are checked
--exclude	list[str]	[]	-	Glob patterns: matching directories are skipped
--tflint/--no-tflint	bool | None	None	TFDO_TFLINT	Run tflint linter alongside fmt+validate
--skip-check-providers/--no-skip-check-providers	bool | None	None	TFDO_SKIP_CHECK_PROVIDERS	Skip provider declaration and credential checks

Changes

Version	Change
0.1.0	Made public

cli_command: destroy_cmd

• source

  Since: 0.1.0

def destroy_cmd(*, auto_approve: bool = False, var_file: Path | None = None, init_mode: InitMode = <InitMode.AUTO: 'auto'>) -> None:
    ...

Run terraform destroy.

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.1.0	Made public

cli_command: init_cmd

• source

  Since: 0.1.0

def init_cmd(*, reconfigure: bool = False, extra_args: list[str] | None = None) -> None:
    ...

Run terraform init with retry on transient errors.

CLI Options:

Flag	Type	Default	Description
--reconfigure	bool	False	Pass -reconfigure to terraform init
extra_args (arg)	list[str] | None	None	Extra arguments forwarded to terraform init

Changes

Version	Change
0.1.0	Made public

cli_command: plan_cmd

• source

  Since: 0.1.0

def plan_cmd(*, out: Path | None = None, json_output: bool = False, var_file: Path | None = None, init_mode: InitMode = <InitMode.AUTO: 'auto'>) -> None:
    ...

Run terraform plan.

CLI Options:

Flag	Type	Default	Env Var	Description
-o, --out	Path | None	None	-	Write the plan to a file
--json	bool	False	-	Output plan in JSON format
--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.1.0	Made public

class: InitMode

• source

  Since: 0.2.0

class InitMode(StrEnum):
    ...

Changes

Version	Change
0.2.0	Made public