# LocalStack AWS CLI
[![PyPI version][pypi-version]][pypi]
This package provides the `awslocal` command, which is a thin wrapper around the `aws`
command line interface for use with [LocalStack](https://github.com/localstack/localstack).
## Installation
You can install the `awslocal` command via `pip`:
```console
pip install awscli-local[ver1]
```
Note that the command above also installs the latest version of the underlying AWS CLI version 1 (`awscli`) package. Use this command if you prefer to manage your own version of `awscli` (e.g., `v1`/`v2`) and install the wrapper script only:
```console
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 [this section](#Limitations) for more details).
## Usage
The `awslocal` command has the same usage as the `aws` command. For detailed usage, please refer to the manual pages of `aws help`.
## Example
Instead of the following command ...
```console
aws --endpoint-url=http://localhost:4566 kinesis list-streams
```
... you can simply use this:
```console
awslocal kinesis list-streams
```
## Configurations
You can use the following environment variables for configuration:
* `AWS_ENDPOINT_URL`: The endpoint URL to connect to (takes precedence over `USE_SSL`/`LOCALSTACK_HOST` below).
Useful when you have LocalStack bound to a different host (e.g., within docker-compose).
* `LOCALSTACK_HOST` (deprecated): A <hostname>:<port> variable defining where to find LocalStack (default: localhost:4566).
* `USE_SSL` (deprecated): Whether to use SSL when connecting to LocalStack (default: False).
## Completion
`awscli` provides a neat command completion feature which is compatible with most modern shells which can also be used with `awslocal`.
### Usage instructions
The command completion will automatically suggest commands and parameters when using the completion key (which is typically the _Tab_ key):
```sh
$ awslocal dynamodb d<TAB>
delete-backup describe-global-table
delete-item describe-global-table-settings
delete-table describe-limits
describe-backup describe-table
describe-continuous-backups describe-table-replica-auto-scaling
describe-contributor-insights describe-time-to-live
describe-endpoints
```
### Configuration
- Follow the official guide on setting up the command completion for the `aws` CLI: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-completion.html
- While enabling the command completion for your shell, **make sure to register the completion for `awslocal` as well**.
For example, if you are using `bash`, you would add the following commands to your `~/.bashrc`:
```sh
complete -C '/usr/local/bin/aws_completer' aws
complete -C '/usr/local/bin/aws_completer' awslocal
```
- Follow the instructions for the shell you are using. For some shells you might need to register a different command or enable certain compatibility plugins (like `zsh`).
## Limitations
* Please note that there is a known limitation for using the `cloudformation package ...` command with the AWS CLI v2. Currently it is not possible to specify the S3 endpoint URL, and this issue is [not yet resolved](https://github.com/aws/aws-cli/pull/3309) on AWS side. The problem is that the AWS CLI v2 is [not available as a package on pypi.org](https://github.com/aws/aws-cli/issues/4947), 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 inofficial 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:
```sh
virtualenv .venv
. .venv/bin/activate
pip install https://github.com/boto/botocore/archive/v2.zip https://github.com/aws/aws-cli/archive/v2.zip
```
## Change Log
* v0.22.0: Use fallback for endpoint detection. Should prevent most cases of `Unable to find LocalStack endpoint for service ...`
* v0.21.1: Introducing semantic versioning and list of services without endpoints
* v0.21: Use placeholder credentials and region only if Boto cannot not find them, fix output streaming for logs tail call
* v0.20: Small fixes for Python 2.x backward compatibility
* v0.19: Patch botocore to skip adding `data-` host prefixes to endpoint URLs
* v0.18: Pass `SYSTEMROOT` env variable to fix "_Py_HashRandomization_Init" error on Windows
* v0.17: Remove obsolete/erroneous FORCE_V2 flag
* v0.16: Minor fix reading addressing_style in profile config
* v0.15: Fix lookup of v1/v2 AWS CLI version, apply --s3-endpoint-url only for v1
* v0.14: Quote file name for windows to allow folder names with spaces
* v0.13: Fix extra requires for newer pip versions
* v0.12: Support v1 and v2 of underlying `awscli` installation
* v0.9: Add `--s3-endpoint-url` by default to fix "cloudformation package" command
* v0.9: Support for `DEFAULT_REGION` environment variable
* v0.8: Switch to using edge port for all service endpoints by default
* v0.7: Apply runtime patch to aws-cli to enable `--s3-endpoint-url` CloudFormation parameter
* v0.6: Start `aws` CLI command in-memory instead of calling external process
* v0.5: Support piping binary files to stdout; add .bat file for Windows
* v0.4: Minor fix for Python 3 compatibility
* v0.3: Add support for additional service endpoints
* v0.2: Enable SSL connections; refactor code
* v0.1: Initial release
## Alternative
This package can be replaced by a single bash alias, except for `cloudformation package ...` as this command requires an additional `--s3-endpoint-url` parameter:
```console
alias awslocal="AWS_ACCESS_KEY_ID=test AWS_SECRET_ACCESS_KEY=test AWS_DEFAULT_REGION=${DEFAULT_REGION:-$AWS_DEFAULT_REGION} aws --endpoint-url=http://${LOCALSTACK_HOST:-localhost}:4566"
```
## License
This software library is released under the Apache License, Version 2.0 (see `LICENSE`).
[pypi-version]: https://img.shields.io/pypi/v/awscli-local.svg
[pypi]: https://pypi.org/project/awscli-local/
Raw data
{
"_id": null,
"home_page": "https://github.com/localstack/awscli-local",
"name": "awscli-local",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "LocalStack Team",
"author_email": "info@localstack.cloud",
"download_url": "https://files.pythonhosted.org/packages/25/f9/023c80ea27d67b0930f116597fd55a93f84de9b05d18b38c7d2d5d75c1c9/awscli-local-0.22.0.tar.gz",
"platform": null,
"description": "# LocalStack AWS CLI\n\n[![PyPI version][pypi-version]][pypi]\n\nThis package provides the `awslocal` command, which is a thin wrapper around the `aws`\ncommand line interface for use with [LocalStack](https://github.com/localstack/localstack).\n\n## Installation\n\nYou can install the `awslocal` command via `pip`:\n\n```console\npip install awscli-local[ver1]\n```\n\nNote that the command above also installs the latest version of the underlying AWS CLI version 1 (`awscli`) package. Use this command if you prefer to manage your own version of `awscli` (e.g., `v1`/`v2`) and install the wrapper script only:\n```console\npip install awscli-local\n```\n\n**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 [this section](#Limitations) for more details).\n\n## Usage\n\nThe `awslocal` command has the same usage as the `aws` command. For detailed usage, please refer to the manual pages of `aws help`.\n\n## Example\n\nInstead of the following command ...\n\n```console\naws --endpoint-url=http://localhost:4566 kinesis list-streams\n```\n\n... you can simply use this:\n\n```console\nawslocal kinesis list-streams\n```\n\n## Configurations\n\nYou can use the following environment variables for configuration:\n\n* `AWS_ENDPOINT_URL`: The endpoint URL to connect to (takes precedence over `USE_SSL`/`LOCALSTACK_HOST` below).\n Useful when you have LocalStack bound to a different host (e.g., within docker-compose).\n* `LOCALSTACK_HOST` (deprecated): A <hostname>:<port> variable defining where to find LocalStack (default: localhost:4566).\n* `USE_SSL` (deprecated): Whether to use SSL when connecting to LocalStack (default: False).\n\n## Completion\n\n`awscli` provides a neat command completion feature which is compatible with most modern shells which can also be used with `awslocal`.\n\n### Usage instructions\n\nThe command completion will automatically suggest commands and parameters when using the completion key (which is typically the _Tab_ key):\n\n```sh\n$ awslocal dynamodb d<TAB>\ndelete-backup describe-global-table\ndelete-item describe-global-table-settings\ndelete-table describe-limits\ndescribe-backup describe-table\ndescribe-continuous-backups describe-table-replica-auto-scaling\ndescribe-contributor-insights describe-time-to-live\ndescribe-endpoints\n```\n\n### Configuration\n\n- Follow the official guide on setting up the command completion for the `aws` CLI: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-completion.html\n- While enabling the command completion for your shell, **make sure to register the completion for `awslocal` as well**.\n\n For example, if you are using `bash`, you would add the following commands to your `~/.bashrc`:\n ```sh\n complete -C '/usr/local/bin/aws_completer' aws\n complete -C '/usr/local/bin/aws_completer' awslocal\n ```\n- Follow the instructions for the shell you are using. For some shells you might need to register a different command or enable certain compatibility plugins (like `zsh`).\n\n## Limitations\n\n* Please note that there is a known limitation for using the `cloudformation package ...` command with the AWS CLI v2. Currently it is not possible to specify the S3 endpoint URL, and this issue is [not yet resolved](https://github.com/aws/aws-cli/pull/3309) on AWS side. The problem is that the AWS CLI v2 is [not available as a package on pypi.org](https://github.com/aws/aws-cli/issues/4947), but is instead shipped as a binary package that cannot be easily patched from `awslocal`. To work around this issue, you have 2 options:\n\n - Downgrade to the v1 AWS CLI (this is the recommended approach)\n - There is an inofficial 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:\n```sh\nvirtualenv .venv\n. .venv/bin/activate\npip install https://github.com/boto/botocore/archive/v2.zip https://github.com/aws/aws-cli/archive/v2.zip\n```\n\n## Change Log\n\n* v0.22.0: Use fallback for endpoint detection. Should prevent most cases of `Unable to find LocalStack endpoint for service ...`\n* v0.21.1: Introducing semantic versioning and list of services without endpoints\n* v0.21: Use placeholder credentials and region only if Boto cannot not find them, fix output streaming for logs tail call\n* v0.20: Small fixes for Python 2.x backward compatibility\n* v0.19: Patch botocore to skip adding `data-` host prefixes to endpoint URLs\n* v0.18: Pass `SYSTEMROOT` env variable to fix \"_Py_HashRandomization_Init\" error on Windows\n* v0.17: Remove obsolete/erroneous FORCE_V2 flag\n* v0.16: Minor fix reading addressing_style in profile config\n* v0.15: Fix lookup of v1/v2 AWS CLI version, apply --s3-endpoint-url only for v1\n* v0.14: Quote file name for windows to allow folder names with spaces\n* v0.13: Fix extra requires for newer pip versions\n* v0.12: Support v1 and v2 of underlying `awscli` installation\n* v0.9: Add `--s3-endpoint-url` by default to fix \"cloudformation package\" command\n* v0.9: Support for `DEFAULT_REGION` environment variable\n* v0.8: Switch to using edge port for all service endpoints by default\n* v0.7: Apply runtime patch to aws-cli to enable `--s3-endpoint-url` CloudFormation parameter\n* v0.6: Start `aws` CLI command in-memory instead of calling external process\n* v0.5: Support piping binary files to stdout; add .bat file for Windows\n* v0.4: Minor fix for Python 3 compatibility\n* v0.3: Add support for additional service endpoints\n* v0.2: Enable SSL connections; refactor code\n* v0.1: Initial release\n\n## Alternative\n\nThis package can be replaced by a single bash alias, except for `cloudformation package ...` as this command requires an additional `--s3-endpoint-url` parameter:\n```console\nalias awslocal=\"AWS_ACCESS_KEY_ID=test AWS_SECRET_ACCESS_KEY=test AWS_DEFAULT_REGION=${DEFAULT_REGION:-$AWS_DEFAULT_REGION} aws --endpoint-url=http://${LOCALSTACK_HOST:-localhost}:4566\"\n```\n\n## License\n\nThis software library is released under the Apache License, Version 2.0 (see `LICENSE`).\n\n[pypi-version]: https://img.shields.io/pypi/v/awscli-local.svg\n[pypi]: https://pypi.org/project/awscli-local/\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Thin wrapper around the \"aws\" command line interface for use with LocalStack",
"version": "0.22.0",
"project_urls": {
"Homepage": "https://github.com/localstack/awscli-local"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25f9023c80ea27d67b0930f116597fd55a93f84de9b05d18b38c7d2d5d75c1c9",
"md5": "ae2ef126b901f803ac06487a1b186abf",
"sha256": "3807cf2ee4bbdd4df4dfc8bef027f25bde523dcaf8119720f677ed95ebba66a4"
},
"downloads": -1,
"filename": "awscli-local-0.22.0.tar.gz",
"has_sig": false,
"md5_digest": "ae2ef126b901f803ac06487a1b186abf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11373,
"upload_time": "2023-12-28T09:57:45",
"upload_time_iso_8601": "2023-12-28T09:57:45.360538Z",
"url": "https://files.pythonhosted.org/packages/25/f9/023c80ea27d67b0930f116597fd55a93f84de9b05d18b38c7d2d5d75c1c9/awscli-local-0.22.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-28 09:57:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "localstack",
"github_project": "awscli-local",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "awscli-local"
}
JSON
