tfmate
Getting Started
Installation
Prerequisites
Installation Methods
From PyPI with
pip
From PyPI with
uv
From Source
Verification
Configuration
Getting Help
Quickstart Guide
Prerequisites
Configuration
Basic Usage
Get Help
Analyze Terraform Configuration
List AWS Services
Get Terraform Version
Show Settings
Output Formats
Next Steps
Getting Help
User Guide
Using the Command Line Interface
Getting Help
Basic Help
Command Structure
Global Options
Analysis Commands
Analyze Configuration
AWS Commands
List AWS Services
Terraform Commands
Settings Commands
Show Settings
Get Terraform Version
Show Settings
Output Formats
JSON Format
Table Format (Default)
Text Format
Configuration
Examples
Basic Usage Examples
Advanced Usage Examples
Scripting Examples
Error Handling
Common Error Scenarios
Troubleshooting
Debugging Commands
Common Issues
Best Practices
Output Format Selection
Configuration Management
Directory Organization
Configuration: Command Line Tool
Configuration Methods
Configuration Files
File Locations
File Format
Configuration Options
Environment Variables
Environment Variable Mapping
Command-Line Options
Global Options
Option Reference
Configuration Examples
Basic Setup
Development Environment
Production Environment
AWS-Specific Configuration
Scripting Configuration
Network-Specific Configuration
Slow Networks
Security Considerations
Configuration File Security
Environment Variable Security
Troubleshooting Configuration
Configuration Debugging
Common Issues
Configuration Validation
Validation Rules
Error Messages
Best Practices
Configuration Management
Configuration Templates
Basic Template
Production Template
Development Template
Scripting Template
Frequently Asked Questions
General Questions
What is tfmate?
What Terraform versions does tfmate support?
What backends does tfmate support?
Installation Issues
How do I install tfmate?
I get a “command not found” error after installation
Usage Questions
How do I list AWS services?
How do I get the Terraform version from a state file?
How do I analyze a Terraform configuration?
Backend and Credential Issues
How does tfmate handle AWS credentials?
I get “Access denied” errors when accessing S3 state
I get “State file not found” errors
How do I use tfmate with Terraform Enterprise?
Output and Formatting Issues
How do I change the output format?
How do I enable verbose output?
How do I suppress output except errors?
Configuration Issues
How do I use a custom configuration file?
What configuration options are available?
Troubleshooting
The tool is slow when accessing S3 state
I get “Unsupported state version” errors
The tool crashes with “Invalid JSON” errors
I get “Module not found” errors
Performance and Limitations
What are the performance characteristics?
Are there any limitations?
Can I use tfmate in CI/CD pipelines?
Getting Help
Where can I get more help?
How do I report a bug?
Development
Contributing
Instructions for contributors
Preconditions for working on this project
Python environment
Coding Guidelines
Building the documentation
Pull request guidelines
Use atomic commits
Commit message format
Commit message format
Guidelines for writing code for tfmate
Project Overview
Coding Guidelines
General
Code
CLI Design
Testing
Integration Tests
Project Documentation
Testing Guide
Running Tests
Basic Test Execution
Test Categories
Running Integration Tests
Test Configuration
Coverage Reports
Adding New Tests
Test Structure
Test Naming Conventions
Unit Test Guidelines
CLI Test Guidelines
Mocking Guidelines
Integration Test Guidelines
Test Fixtures
Using Fixtures
Creating Fixtures
Test Data
Testing Best Practices
Error Testing
Performance Testing
Edge Cases
Testing CLI Commands
CLI Testing Patterns
Testing Error Handling
Testing with Real Data
Integration Testing Setup
Testing Different Backends
Continuous Integration
CI Configuration
Test Commands for CI
Debugging Tests
Debugging Failed Tests
Common Test Issues
Test Maintenance
Keeping Tests Updated
Test Documentation
Running Tests in Development
Development Workflow
Quick Test Commands
tfmate
Index
Index