localstack/terraform-local is a developer-focused project on GitHub with 325 stars, written primarily in Python. Terraform CLI wrapper to deploy your Terraform applications directly to LocalStack
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
[!WARNING]
tflocal is deprecated. Use lstk terraform instead.
tflocal no longer receives updates.
Get started with lstk, the new LocalStack CLI: docs.localstack.cloud/.../lstk
Switch your scripts and CI workflows to lstk terraform: docs.localstack.cloud/.../lstk/migration
This package provides tflocal - a small wrapper script to run Terraform against LocalStack.
Prerequisites
Python 3.x
pip or pipx
terraform
How it works
The script uses the Terraform Override mechanism and creates a temporary file localstack_providers_override.tf to configure the endpoints for the AWS provider section. The endpoints for all services are configured to point to the LocalStack API (http://localhost:4566 by default).
Installation
The recommended way to install tflocal is using pipx, which installs Python CLI tools in their own isolated environments. This avoids conflicts with system packages and the externally-managed-environment error (PEP 668) seen on modern Linux distributions.
1) Recommended: Using pipx
First, ensure pipx is installed.
On Debian/Ubuntu:
sudo apt install pipx
Or, using pip (for other systems):
pip install --user pipx
Then, run pipx ensurepath to add pipx's binaries to your system's PATH. You may need to restart your shell for this to take effect.
Install tflocal with pipx:
pipx install terraform-local
To upgrade tflocal in the future, run: pipx upgrade terraform-local.
2) Alternative: Using a Virtual Environment
If you prefer not to use pipx, you can install tflocal into a standard Python virtual environment (venv):
Bash
Create a virtual environment (e.g., in your project directory)
python3 -m venv .venv
Activate it
source .venv/bin/activate
Install the package
pip install terraform-local
Note: You must activate this venv (source .venv/bin/activate) every time you want to use the tflocal command.
Configurations
The following environment variables can be configured:
DRY_RUN: Generate the override file without invoking Terraform
TF_CMD: Terraform command to call (default: terraform)
AWS_ENDPOINT_URL: hostname and port of the target LocalStack instance
LOCALSTACK_HOSTNAME: (Deprecated) host name of the target LocalStack instance
EDGE_PORT: (Deprecated) port number of the target LocalStack instance
S3_HOSTNAME: special hostname to be used to connect to LocalStack S3 (default: s3.localhost.localstack.cloud)
USE_EXEC: whether to use os.exec instead of subprocess.Popen (try using this in case of I/O issues)
<SERVICE>_ENDPOINT: setting a custom service endpoint, e.g., COGNITO_IDP_ENDPOINT=http://example.com
AWS_DEFAULT_REGION: the AWS region to use (default: us-east-1, or determined from local credentials if boto3 is installed)
CUSTOMIZE_ACCESS_KEY: enables to override the static AWS Access Key ID. The following cases are taking precedence over each other from top to bottom:
AWS_ACCESS_KEY_ID environment variable is set
access_key is set in the Terraform AWS provider
AWS_PROFILE environment variable is set and configured
AWS_DEFAULT_PROFILE environment variable is set and configured
default profile's credentials are configured
falls back to the default AWS_ACCESS_KEY_ID mock value
AWS_ACCESS_KEY_ID: AWS Access Key ID to use for multi account setups (default: test -> account ID: 000000000000)
SKIP_ALIASES: Allows to skip generating AWS provider overrides for specified aliased providers, e.g. SKIP_ALIASES=aws_secrets,real_aws
ADDITIONAL_TF_OVERRIDE_LOCATIONS: Comma-separated list of folder paths that will also receive a temporary localstack_providers_override.tf file
DISABLE_DEPRECATION_NOTICE: set to 1 to hide the deprecation notice
Usage
The tflocal command has the same usage as the terraform command. For detailed usage,
please refer to the man pages of terraform --help.
Validation errors when using local terraform modules
Note that if your project uses local terraform modules, and those modules reference providers, those folders also need to receive a temporary localstack_providers_override.tf file. Without it, you would get an error that looks like this when starting to process code from inside the module
╷
│ Error: No valid credential sources found
│
│ with module.lambda.provider["registry.terraform.io/hashicorp/aws"],
│ on ../../providers.tf line 11, in provider "aws":
│ 11: provider "aws" {
│
│ Please see https://registry.terraform.io/providers/hashicorp/aws
│ for more information about providing credentials.
│
│ Error: failed to refresh cached credentials, no EC2 IMDS role found, operation error ec2imds: GetMetadata, access disabled to EC2 IMDS via client option, or "AWS_EC2_METADATA_DISABLED" environment variable
To address this issue, you may include a comma-separated list of folder paths that will recieve additional override files via an environment variable
ADDITIONAL_TF_OVERRIDE_LOCATIONS=/path/to/module1,path/to/module2 tflocal plan
See this issue for more discussion
Change Log
v0.27.0: Print a deprecation notice that points to lstk terraform
v0.26.0: Fix compatibility with python-hcl2 v8+ by using SerializationOptions to handle quoted dict keys, block metadata, and comments
v0.25.0: Improve s3control local endpoint override and respect AWS_ENDPOINT_URL configuration for mwaa
v0.24.1: Exclude broken python-hcl2 version from requirements
v0.24.0: Add support to return terraform-local version when calling tflocal -version and fix AWS provider detection
v0.23.1: Fix endpoint overrides for Terraform AWS provider >= 6.0.0-beta2
v0.23.0: Add support for terraform_remote_state with s3 backend to read the state stored in local S3 backend; fix S3 backend config detection with multiple Terraform blocks
v0.22.0: Fix S3 backend forcing DynamoDB State Lock to be enabled by default
v0.21.0: Add ability to drop an override file in additional locations
How active is development on localstack/terraform-local?
The most recent commit recorded on localstack/terraform-local was 1 month ago, based on the GitHub push timestamp. The repository has 43 forks — one of the better signals of community interest.
How does localstack/terraform-local compare to other Developer Tools projects?
localstack/terraform-local is tracked by TopGit in the Developer Tools category, with 325 GitHub stars and written in Python. Browse the Developer Tools topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does localstack/terraform-local have?
localstack/terraform-local has 325 GitHub stars — refresh the page for the live number, or check github.com/localstack/terraform-local. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What is localstack/terraform-local?
localstack/terraform-local (localstack/terraform-local) is a Python project on GitHub. From the project's own README: Terraform CLI wrapper to deploy your Terraform applications directly to LocalStack
What language is localstack/terraform-local written in?
localstack/terraform-local is written primarily in Python. GitHub's language field is based on the largest share of bytes in the default branch.
What topics is localstack/terraform-local associated with?
GitHub's repository topics for localstack/terraform-local: "localstack", "terraform". TopGit's editorial category is Developer Tools.
Why is localstack/terraform-local categorized under Developer Tools?
TopGit places localstack/terraform-local in the Developer Tools category based on its GitHub topics and description (tagged: "localstack", "terraform"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Is terraform-local worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of terraform-local.