AWS Command Line Interface

The AWS Command Line Interface (CLI) is a unified tool to manage AWS services from the command line. All CLI commands that access can be run against LocalStack.

There are two CLI alternatives:

AWS CLI

Use the below command to install , if not installed already.

Configure AWS test environment variables and add the --endpoint-url=<localstack-url> flag to your aws CLI invocations. For example:

$ export AWS_SECRET_ACCESS_KEY="test"
$ export AWS_DEFAULT_REGION="us-east-1"
$ aws --endpoint-url=http://localhost:4566 kinesis list-streams

Create a configuration profile. The configuration file will be created under ~/.aws directory and in the example below, using the default profile:

$ aws configure --profile default

Note Please use test as value for AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to make pre-signed URLs for S3 buckets work. Our pre-signed URL signature verification algorithm validates the pre-signed URL and its expiration.

Verify the current configuration:

aws configure list

Installation

You can install the awslocal command via pip:

Note that the command above also installs the latest version of the underlying AWS CLI version 1 () package. Use this command if you prefer to manage your own version of awscli (e.g., v1/v2) and install the wrapper script only:

$ pip install awscli-local

Note: Automatic installation of AWS CLI version 2 is currently not supported yet (at the time of writing there is no official pypi package for v2 available), but the awslocal technically also works with AWS CLI v2 (see for more details).

The awslocal command has the same usage as the aws command. For detailed usage, please refer to the man pages of aws help.

awslocal kinesis list-streams

Configurations

You can use the following environment variables for configuration:

Verify the current configuration:

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 , 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:

AWS CLI v2 with Docker and LocalStack

By default, the container running is isolated from 0.0.0.0:4566 on the host machine, that means that aws-cli cannot reach localstack through your shell.

To ensure that the two docker containers can communicate create a network on the docker engine:

$ docker network create localstack

Then modify the docker-compose.yml specifying the network to use:

networks:
  default:
    external:
      name: "localstack"

Run AWS Cli v2 docker container using this network (example):

$ docker run --network localstack --rm -it amazon/aws-cli --endpoint-url=http://localstack:4566 lambda list-functions
{
    "Functions": []
}

If you use AWS CLI v2 from a docker container often, create an alias:

So you can type:

$ laws lambda list-functions
{
    "Functions": []