azurerm-cli

CLI tool to fetch Terraform AzureRM provider documentation from the official Terraform Registry.

Installation

# Install from PyPI
pip install azurerm-cli

# Or install from source
pip install -e .

Usage

Fetch documentation

# Fetch resource documentation (latest version)
azurerm-cli doc azurerm_virtual_machine

# Fetch data source documentation
azurerm-cli doc azurerm_virtual_network --category data-sources

# Fetch specific version
azurerm-cli doc azurerm_virtual_machine --version 3.50.0

# Save to file
azurerm-cli doc azurerm_virtual_machine --output docs/vm.md

List resources

# List all resources
azurerm-cli list resources

# List data sources
azurerm-cli list data-sources

# List for specific version
azurerm-cli list resources --version 4.64.0

# Limit results
azurerm-cli list resources --limit 10

Search

# Search resources
azurerm-cli search redis

# Search data sources
azurerm-cli search storage --category data-sources

# Search with version
azurerm-cli search virtual_network --version 3.50.0

Configuration

Default Version

You can set a default provider version so you don't need to specify --version each time:

# Set default version using --set-default flag
azurerm-cli doc azurerm_virtual_machine --version 4.60.0 --set-default

# Or use environment variable
export AZurerm_CLI_VERSION=4.60.0

After setting a default, commands will use that version automatically:

azurerm-cli doc azurerm_virtual_machine  # Uses default version 4.60.0

The config file is stored at ~/.azurerm-cli/config. To clear the default, delete this file.

Options

• --verbose, -V: Enable verbose output
• --version: Show version information

Development

# Install with dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run with verbose
python -m azurerm_cli doc azurerm_virtual_machine -V

License

MIT