tfdc provider export
Export all docs for a provider version to local files.
Usage
Single provider (legacy mode)
tfdc provider export \
-name aws \
-version 6.31.0 \
-out-dir ./docs
Required: -name, -version, -out-dir
Lockfile mode (multi-provider)
tfdc -chdir=./infra provider export -out-dir ./docs
Required: -chdir (global flag), -out-dir
Detects .terraform.lock.hcl and exports all listed providers. Filter with -name:
tfdc -chdir=./infra provider export -name aws -out-dir ./docs
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
-name |
Yes (legacy) | Provider name | |
-version |
Yes (legacy) | Provider version (explicit semver) | |
-out-dir |
Yes | Output directory | |
-namespace |
No | hashicorp |
Provider namespace |
-format |
No | markdown |
Persist format: markdown or json |
-categories |
No | all |
Categories to export (comma-separated) |
-path-template |
No | See below | Output path template |
-clean |
No | off | Remove previous export before writing |
Output layout
Default path template: {out}/terraform/{namespace}/{provider}/{version}/docs/{category}/{slug}.{ext}
Example: docs/terraform/hashicorp/aws/6.31.0/docs/resources/instance.md
Manifest: docs/terraform/hashicorp/aws/6.31.0/docs/_manifest.json
Path template placeholders
{out}, {namespace}, {provider}, {version}, {category}, {slug}, {doc_id}, {ext}
Categories
-categories all expands to: resources, data-sources, ephemeral-resources, functions, guides, overview, actions, list-resources
# Export only resources and data sources
tfdc provider export -name aws -version 6.31.0 -out-dir ./docs -categories resources,data-sources
Examples
# Export AWS provider docs as markdown
tfdc provider export -name aws -version 6.31.0 -out-dir ./terraform-docs
# Export as JSON
tfdc provider export -name aws -version 6.31.0 -out-dir ./terraform-docs -format json
# Clean export (remove previous)
tfdc provider export -name aws -version 6.31.0 -out-dir ./terraform-docs -clean
# Export all providers from lockfile
tfdc -chdir=./my-project provider export -out-dir ./terraform-docs
Converted and distributed by TomeVault — claim your Tome and manage your conversions.