{"id":13820657,"url":"https://github.com/localstack/awscli-local","last_synced_at":"2025-10-19T22:13:05.935Z","repository":{"id":22522549,"uuid":"96595434","full_name":"localstack/awscli-local","owner":"localstack","description":"💲  \"awslocal\" - Thin wrapper around the \"aws\" command line interface for use with LocalStack","archived":false,"fork":false,"pushed_at":"2024-10-09T13:46:43.000Z","size":56,"stargazers_count":1152,"open_issues_count":5,"forks_count":92,"subscribers_count":26,"default_branch":"master","last_synced_at":"2025-04-08T22:12:31.967Z","etag":null,"topics":["aws","cli","localstack"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/localstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-08T04:16:23.000Z","updated_at":"2025-04-08T06:13:24.000Z","dependencies_parsed_at":"2024-06-18T13:54:56.265Z","dependency_job_id":"2772dedc-a5cc-4218-8c2e-3ca942642782","html_url":"https://github.com/localstack/awscli-local","commit_stats":{"total_commits":49,"total_committers":22,"mean_commits":2.227272727272727,"dds":0.4897959183673469,"last_synced_commit":"034919b8aa0c48c185ccfa7b31a256f45c5853ed"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack%2Fawscli-local","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack%2Fawscli-local/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack%2Fawscli-local/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack%2Fawscli-local/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/localstack","download_url":"https://codeload.github.com/localstack/awscli-local/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254049560,"owners_count":22006084,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","cli","localstack"],"created_at":"2024-08-04T08:01:06.715Z","updated_at":"2025-10-19T22:13:05.929Z","avatar_url":"https://github.com/localstack.png","language":"Python","readme":"# 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\nIf you're on macOS or use ZSH, please use the following command to install `awslocal` via `pip`:\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 \u003chostname\u003e:\u003cport\u003e 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\u003cTAB\u003e\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.2: Display full stack traces only in `--debug` mode; non-debug runs now show concise error messages, consistent with `awscli` behavior.\n* v0.22.1: Fix issue with cfn package and cfn deploy with awscli \u003e= 1.41.9\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","funding_links":[],"categories":["Infrastructure as Code","Cryptocurrency","IDE and Tools"],"sub_categories":["Crossplane","LINQ"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalstack%2Fawscli-local","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flocalstack%2Fawscli-local","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalstack%2Fawscli-local/lists"}