Deprecated Wrapper Scripts

The following (now deprecated) wrapper scripts were used in conjunction with LocalStack, to direct the aws, terraform, sam, and cdk commands to LocalStack endpoints.

• awslocal - Runs AWS CLI commands against LocalStack.
• tflocal - Runs Terraform against LocalStack.
• samlocal - Runs AWS SAM CLI commands against LocalStack.
• cdklocal - Runs AWS CDK commands against LocalStack.

See the AWS CLI, Terraform, AWS SAM, and AWS CDK pages for the current lstk-based workflow.

awslocal serves as a thin wrapper and a substitute for the standard aws command, enabling you to run AWS CLI commands within the LocalStack environment without specifying the --endpoint-url parameter or a profile.

Install the awslocal command using the following command:

pip install awscli-local[ver1]

The awslocal command shares identical usage with the standard aws command. For comprehensive usage instructions, refer to the manual pages by running awslocal help.

awslocal kinesis list-streams

Please note that there is a known limitation for using the cloudformation package ... command with the AWS CLI v2. The problem is that the AWS CLI v2 is not available as a package on pypi.org, but is instead shipped as a binary package that cannot be easily patched from awslocal. To work around this issue, you have 2 options:

• Downgrade to the v1 AWS CLI (this is the recommended approach)
• There is an unofficial way to install AWS CLI v2 from sources. We do not recommend this, but it is technically possible. Also, you should install these libraries in a Python virtualenv, to avoid version clashes with other libraries on your system:

virtualenv .venv
. .venv/bin/activate
pip install https://github.com/boto/botocore/archive/v2.zip https://github.com/aws/aws-cli/archive/v2.zip

Please also note there is a known limitation for issuing requests using --no-sign-request with the AWS CLI. LocalStack’s routing mechanism depends on the signature of each request to identify the correct service for the request. Thus, adding the flag --no-sign-requests provokes your request to reach the wrong service. One possible way to address this is to use the awslocal CLI instead of AWS CLI.

tflocal is a small wrapper script to run Terraform against LocalStack. It 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).

To install the tflocal command, you can use pip (assuming you have a local Python installation):

pip install terraform-local

After installation, you can use the tflocal command, which has the same interface as the terraform command line.

tflocal --help

tflocal init
tflocal apply

You can use the TF_CMD environment variable with tflocal to specify the tofu binary to call:

TF_CMD=tofu tflocal --help

samlocal is a wrapper for the sam command line interface, facilitating the use of the SAM framework with LocalStack. When executing deployment commands like samlocal [ build | deploy | validate | package ], the script configures the SAM settings for LocalStack and runs the specified SAM command.

You can install the samlocal wrapper script by running the following command:

pip install aws-sam-cli-local

samlocal init
samlocal deploy --guided

cdklocal is a thin wrapper script for using the AWS CDK library against local APIs provided by LocalStack.

The cdklocal command line is published as an npm library:

# Install globally
npm install -g aws-cdk-local aws-cdk

# Verify it installed correctly
cdklocal --version
# e.g. 1.65.5

cdklocal can be used as a drop-in replacement of where you would otherwise use cdk when targeting the AWS Cloud.

cdklocal --help

# create sample app
mkdir /tmp/test; cd /tmp/test
cdklocal init sample-app --language=javascript

# bootstrap localstack environment
cdklocal bootstrap

# deploy the sample app
cdklocal deploy

The following environment variables can be configured:

• AWS_ENDPOINT_URL: The endpoint URL (i.e., protocol, host, and port) to connect to LocalStack (default: http://localhost.localstack.cloud:4566)
• LAMBDA_MOUNT_CODE: Whether to use local Lambda code mounting (via setting hot-reload S3 bucket name)

cdklocal works with all installed versions of the Node.js aws-cdk package. However, issues exist for aws-cdk >= 2.177.0.

For these versions:

• We unset AWS-related environment variables like AWS_PROFILE before calling cdk.
• We explicitly set AWS_ENDPOINT_URL and AWS_ENDPOINT_URL_S3 to point to LocalStack.

Some environment variables may cause conflicting config, such as wrong region or accidental deploys to real AWS. To allow specific variables (e.g., AWS_REGION), use AWS_ENVAR_ALLOWLIST:

AWS_ENVAR_ALLOWLIST=AWS_REGION,AWS_DEFAULT_REGION AWS_DEFAULT_REGION=eu-central-1 AWS_REGION=eu-central-1 cdklocal ...

If you manually set AWS_ENDPOINT_URL, it will be used. You must also set AWS_ENDPOINT_URL_S3, and it must include .s3. to correctly identify S3 API calls. See full configuration details on our configuration docs.