Skip to content

ROOT

Symbol Details

cli_command: get_settings

def get_settings() -> TfDoSettings:
    ...

Changes

Version Change
0.1.0 Made public

cli_command: main_callback

def main_callback(*, binary: str = 'terraform', tf_version: str | None = None, work_dir: Path | None = None, interactive: InteractiveMode = <InteractiveMode.AUTO: 'auto'>, log_level: str = 'INFO', passthrough: bool = False, verbose_shell: bool = False) -> None:
    ...

CLI Options:

Flag Type Default Env Var Description
-b, --binary str 'terraform' TFDO_BINARY Terraform binary name or path
-V, --tf-version str | None None TFDO_TF_VERSION Terraform version (uses mise for version selection)
-w, --work-dir Path | None None TFDO_WORK_DIR Working directory for terraform commands
--interactive InteractiveMode <InteractiveMode.AUTO: 'auto'> TFDO_INTERACTIVE Interactive mode: auto (detect TTY), always (force stdin), never (no stdin) [auto, always, never]
--log-level str 'INFO' - Log level for tfdo
--passthrough bool False - Disable parsed output, pass raw ANSI from terraform
--verbose-shell bool False TFDO_VERBOSE_SHELL Log successful shell command completions

Changes

Version Change
0.1.0 Made public

class: InteractiveMode

class InteractiveMode(StrEnum):
    ...

Changes

Version Change
0.2.0 Made public

class: TfDoUserConfig

class TfDoUserConfig(BaseModel):
    check: CheckConfig | None = None
Field Type Default Since
check CheckConfig | None None 0.3.0

Changes

Version Change
0.3.0 Made public

cli_command: info_cmd

def info_cmd() -> None:
    ...

Show resolved settings, paths, and user config.

Changes

Version Change
0.3.0 Made public