inspect

• MatchingAttributeDescription
• MatchingSchemaResource
• SchemaSearch
• SchemaSearchRowsBehavior
• inspect_api_coverage_cmd
• inspect_hcl_paths_cmd
• inspect_resource_usage_cmd

Symbol Details

cli_command: inspect_hcl_paths_cmd

• source

  Since: 0.4.0

def inspect_hcl_paths_cmd(
    *, path: Path = ".", hidden: bool = False, as_json: bool = False, output: Path | None = None
) -> None: ...

CLI Options:

Flag	Type	Default	Description
--path, -p	Path	'.'	Root directory to scan for Terraform files
--hidden	bool	False	Include hidden directories (dot-prefixed) in the scan
--json	bool	False	Print JSON to stdout
--output, -o	Path | None	None	Write JSON here instead of stdout (requires --json)

Changes

Version	Change
0.4.0	Made public

cli_command: inspect_resource_usage_cmd

• source

  Since: 0.4.0

def inspect_resource_usage_cmd(
    *,
    path: Path = ".",
    mode: str = "all",
    input_only: bool = True,
    provider: str = ...,
    source: str | None = None,
    version: str = ">= 1.0",
    no_cache: bool = False,
    include: list[str] = [],
    exclude: list[str] = [".github/*", "tests/*"],
    description_keywords: list[str] = [],
    resource_ignore: list[str] = [],
    schema_search_path: Path | None = None,
    output: Path | None = None,
) -> None: ...

CLI Options:

Flag	Type	Default	Description
--path, -p	Path	'.'	Root directory to scan for Terraform files
--mode	str	'all'	included | excluded | all
--input-only/--no-input-only	bool	True	Input paths only in v1 (default: on)
--provider	str	required	required_providers local name (e.g. mongodbatlas)
--source	str | None	None	Registry source namespace/type (optional when tfdo has a built-in default for --provider)
--version	str	'>= 1.0'	required_providers version constraint
--no-cache	bool	False	Skip schema cache read and write
--include	list[str]	[]	Glob patterns: only matching directories are checked
--exclude	list[str]	['.github/*', 'tests/*']	Glob patterns: matching directories are skipped (default .github/ and tests/; any --exclude replaces defaults)
--description-keyword, --keyword	list[str]	[]	Search provider schema descriptions for this keyword (repeatable; case-insensitive substring match)
--resource-ignore	list[str]	[]	Omit this resource type from description search results (repeatable; only applies with description search)
--schema-search	Path | None	None	JSON/YAML file with SchemaSearch fields; --keyword/--resource-ignore override file when those lists are non-empty
--output, -o	Path | None	None	Write JSON here instead of stdout

Changes

Version	Change
0.4.0	Made public

class: MatchingAttributeDescription

• source

  Since: 0.5.0

class MatchingAttributeDescription(BaseModel):
    name: str
    keywords: list[str]
    description: str

Field	Type	Default	Since
name	str	-	0.5.0
keywords	list[str]	-	0.5.0
description	str	-	0.5.0

Changes

Version	Change
0.5.0	Made public

class: MatchingSchemaResource

• source

  Since: 0.5.0

class MatchingSchemaResource(BaseModel):
    name: str
    found_in_rows: bool
    matching_attribute_descriptions: list[MatchingAttributeDescription]

Field	Type	Default	Since
name	str	-	0.5.0
found_in_rows	bool	-	0.5.0
matching_attribute_descriptions	list[MatchingAttributeDescription]	-	0.5.0

Changes

Version	Change
0.5.0	Made public

class: SchemaSearch

• source

  Since: 0.5.0

class SchemaSearch(BaseModel):
    description_keywords: list[str] = ...
    resource_ignore: list[str] = ...
    include_data_sources: bool = False
    rows_behavior: SchemaSearchRowsBehavior = <SchemaSearchRowsBehavior.DEFAULT: 'default'>

Field	Type	Default	Since
description_keywords	list[str]	...	0.5.0
resource_ignore	list[str]	...	0.5.0
include_data_sources	bool	False	0.5.0
rows_behavior	SchemaSearchRowsBehavior	<SchemaSearchRowsBehavior.DEFAULT: 'default'>	0.5.0

Changes

Version	Change
0.5.0	Made public

class: SchemaSearchRowsBehavior

• source

  Since: 0.5.0

class SchemaSearchRowsBehavior(StrEnum): ...

Changes

Version	Change
0.5.0	Made public

cli_command: inspect_api_coverage_cmd

• source

  Since: 0.5.0

def inspect_api_coverage_cmd(
    *,
    api_attributes_file: Path = ...,
    provider: str = "mongodbatlas",
    source: str | None = None,
    version: str = ">= 1.0",
    no_cache: bool = False,
    resource: list[str] = [],
    include_computed: bool = True,
    coverage_config_path: Path | None = None,
    output: Path | None = None,
) -> None: ...

CLI Options:

Flag	Type	Default	Description
--api-attributes-file, -a	Path	required	Path to api-attributes.json
--provider	str	'mongodbatlas'	Provider local name
--source	str | None	None	Registry source namespace/type
--version	str	'>= 1.0'	required_providers version constraint
--no-cache	bool	False	Skip schema cache
--resource	list[str]	[]	Filter to specific resource types (repeatable)
--include-computed/--no-include-computed	bool	True	Include computed attrs
--coverage-config, -c	Path | None	None	YAML config with resource mapping and known gaps
--output, -o	Path | None	None	Write JSON here instead of stdout

Changes

Version	Change
0.5.0	Made public