{ "info": { "author": "James Saryerwinnie", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Programming Language :: Python", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6" ], "description": "aws-shell - The interactive productivity booster for the AWS CLI\n================================================================\n\n.. image:: https://aws-developer-blog-media.s3-us-west-2.amazonaws.com/cli/Super-Charge-Your-AWS-Command-Line-Experience-with-aws-shell/aws-shell-final.gif\n\n\nInstallation\n============\n\nThe aws-shell requires python and `pip`_ to install.\nYou can install the aws-shell using `pip`_::\n\n $ pip install aws-shell\n\nIf you are not installing into a virtualenv you can run::\n\n $ sudo pip install aws-shell\n\n**Mac OS X (10.11 El Capitan) users**: There is a known issue with Apple and\nits included python package dependencies (more info at\nhttps://github.com/pypa/pip/issues/3165).\nWe are investigating ways to fix this issue but in the meantime,\nto install the aws-shell, you can run:\n``sudo pip install aws-shell --upgrade --ignore-installed six``\n\nOnce you've installed the aws-shell, you can now run::\n\n $ aws-shell\n\nTo exit the shell, press ``Ctrl-D``.\n\nUpgrading the aws-shell\n-----------------------\n\nIf you want to upgrade to the latest version of the aws-shell,\nyou can run::\n\n $ pip install --upgrade aws-shell\n\nYou can also use this upgrade command whenever a new version of the AWS CLI is\nreleased that includes new services and API updates. You will then be\nable to use these new services and API updates in the aws-shell.\n\nSupported Python Versions\n-------------------------\n\nThe aws-shell works on the same python versions supported by the AWS CLI:\n\n* 2.6.5 and greater\n* 2.7.x and greater\n* 3.3.x and greater\n* 3.4.x and greater\n\n\nConfiguration\n=============\n\nThe aws-shell uses the same configuration settings as the AWS CLI.\nIf you've never used the AWS CLI before, the easiest way to get\nstarted is to run the ``configure`` command::\n\n $ aws-shell\n aws> configure\n AWS Access Key ID [None]: your-access-key-id\n AWS Secret Access Key [None]: your-secret-access-key\n Default region name [None]: region-to-use (e.g us-west-2, us-west-1, etc).\n Default output format [None]:\n aws>\n\nFor more information about configure settings, see the\n`AWS CLI Getting Started Guide`_.\n\nBasic Usage\n===========\n\nThe aws-shell accepts the same commands as the AWS CLI, except you don't\nneed to provide the ``aws`` prefix. For example, here are a few commands\nyou can try::\n\n\n $ aws-shell\n aws> ec2 describe-regions\n {\n \"Regions\": [\n {\n \"Endpoint\": \"ec2.eu-west-1.amazonaws.com\",\n \"RegionName\": \"eu-west-1\"\n },\n ...\n aws> s3 ls\n 2015-12-07 15:03:34 bucket1\n 2015-12-07 15:03:34 bucket2\n aws> dynamodb list-tables --output text\n TABLENAMES First\n TABLENAMES Second\n TABLENAMES Third\n\nProfiles\n--------\n\nThe aws-shell supports AWS CLI profiles. You have two options to use\nprofiles. First, you can provide a profile when you start the aws-shell::\n\n $ aws-shell --profile prod\n aws>\n\nWhen you do this all the server side completion as well as CLI commands\nyou run will automatically use the ``prod`` profile.\n\nYou can also change the current profile while you're in the aws-shell::\n\n $ aws-shell\n aws> .profile demo\n Current shell profile changed to: demo\n\nYou can also check what profile you've configured in the aws-shell using::\n\n aws> .profile\n Current shell profile: demo\n\nAfter changing your profile using the ``.profile`` dot command, all\nserver side completion as well as CLI commands will automatically use\nthe new profile you've configured.\n\n\nFeatures\n========\n\nAuto Completion of Commands and Options\n---------------------------------------\n\nThe aws-shell provides auto completion of commands and\noptions as you type.\n\n\n.. image:: https://cloud.githubusercontent.com/assets/368057/11824078/784a613e-a32c-11e5-8ac5-f1d1873cc643.png\n\n\nShorthand Auto Completion\n-------------------------\n\nThe aws-shell can also fill in an example of the\nshorthand syntax used for various AWS CLI options:\n\n.. image:: https://cloud.githubusercontent.com/assets/368057/11823453/e95d85da-a328-11e5-8b8d-67566eccf9e3.png\n\n\nServer Side Auto Completion\n---------------------------\n\nThe aws-shell also leverages `boto3`_, the AWS SDK for Python, to auto complete\nserver side resources such as Amazon EC2 instance Ids, Amazon Dynamodb table\nnames, AWS IAM user names, Amazon S3 bucket names, etc.\n\nThis feature is under active development. The list of supported resources\ncontinues to grow.\n\n.. image:: https://cloud.githubusercontent.com/assets/368057/11824022/3648b4fc-a32c-11e5-8e18-92f028eb1cee.png\n\n\nFuzzy Searching\n---------------\n\nEvery auto completion value supports fuzzy searching. This enables you to\nspecify the commands, options, and values you want to run with even less\ntyping. You can try typing:\n\n* The first letter of each sub word: ``ec2 describe-reserved-instances-offerings``\n -> ``ec2 drio``\n* A little bit of each word: ``ec2 describe-instances`` -> ``ec2 descinst``\n* Any part of the command: ``dynamodb table`` -> Offers all commands that\n contain the subsequence ``table``.\n\n\n.. image:: https://cloud.githubusercontent.com/assets/368057/11823996/18e69d16-a32c-11e5-80a2-defbaa6a8a80.png\n\nInline Documentation\n--------------------\n\nThe aws-shell will automatically pull up documentation as you type commands.\nIt will show inline documentation for CLI options. There is also a separate\ndocumentation panel that will show documentation for the current command or\noption you are typing. Pressing F9 will toggle focus to the documentation panel\nallowing you to navigate it using your selected keybindings.\n\n\n.. image:: https://cloud.githubusercontent.com/assets/368057/11823320/36ae9b04-a328-11e5-9661-81abfc0afe5a.png\n\n\nFish-Style Auto Suggestions\n---------------------------\n\nThe aws-shell supports Fish-style auto-suggestions. Use the right arrow key to\ncomplete a suggestion.\n\n.. image:: https://cloud.githubusercontent.com/assets/368057/11822961/4bceff94-a326-11e5-87fa-c664e1e82be4.png\n\nCommand History\n---------------\n\nThe aws-shell records the commands you run and writes them to\n``~/.aws/shell/history``. You can use the up and down arrow keys to scroll\nthrough your history.\n\n.. image:: https://cloud.githubusercontent.com/assets/368057/11823211/b5851e9a-a327-11e5-877f-687dc1f90e27.png\n\nToolbar Options\n---------------\n\nThe aws-shell has a bottom toolbar that provides several options:\n\n* ``F2`` toggles between fuzzy and substring matching\n* ``F3`` toggles between VI and Emacs key bindings\n* ``F4`` toggles between single and multi column auto completions\n* ``F5`` shows and hides the help documentation pane\n* ``F9`` toggles focus between the cli and documentation pane\n* ``F10`` or ``Ctrl-D`` exits the aws-shell\n\nAs you toggle options in the toolbar, your preferences are persisted\nto the ``~/.aws/shell/awsshellrc`` file so that the next time you run\nthe aws-shell, your preferences will be restored.\n\n.. image:: https://cloud.githubusercontent.com/assets/368057/11823907/8c3f1e60-a32b-11e5-9f99-fe504ea0a5dc.png\n\nDot Commands\n------------\n\nThe aws-shell provides additional commands specific to the aws-shell.\nThe commands are available by adding the ``.`` prefix before a command.\n\nExiting the Shell\n~~~~~~~~~~~~~~~~~\nYou can run the ``.exit`` or ``.quit`` commands to exit the shell.\n\nCreating Shell Scripts with .edit\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThere are times when you may want to take a sequence of commands\nyou've run in the aws-shell and combine them into a shell script.\nIn addition to the command history that's persisted to the\nhistory file, the aws-shell also keeps track of all the commands\nyou've run since you first started your aws-shell session.\n\nYou can run the ``.edit`` command to open all these commands in\nan editor. The aws-shell will use the ``EDITOR`` environment\nvariable before defaulting to ``notepad`` on Windows and\n``vi`` on other platforms.\n\n::\n\n aws> ec2 describe-instances\n aws> dynamodb list-tables\n aws> .edit\n\nChanging Profiles with .profile\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can change the current AWS CLI profile used by the aws-shell\nby using the ``.profile`` dot command. If you run the ``.profile``\ncommand with no arguments, the currently configured shell profile\nwill be printed.\n\n::\n\n aws> .profile demo\n Current shell profile changed to: demo\n aws> .profile\n Current shell profile: demo\n\n\n.cd\n~~~\n\nYou can change the current working directory of the aws-shell by using\nthe ``.cd`` command::\n\n aws> !pwd\n /usr\n aws> .cd /tmp\n aws> !pwd\n /tmp\n\n\nExecuting Shell Commands\n------------------------\n\nThe aws-shell integrates with other commands in several ways.\nFirst, you can pipe AWS CLI commands to other processes as well\nas redirect output to a file::\n\n aws> dynamodb list-tables --output text | head -n 1\n TABLENAMES First\n aws> dynamodb list-tables --output text > /tmp/foo.txt\n\nSecond, if you want to run a shell command rather than an AWS CLI\ncommand, you can add the ``!`` prefix to your command::\n\n aws> !ls /tmp/\n foo.txt bar.txt\n\nDeveloper Preview Status\n========================\n\nThe aws-shell is currently in developer preview.\nWe welcome feedback, feature requests, and bug reports.\nThere may be backwards incompatible changes made in order\nto respond to customer feedback as we continue to iterate\non the aws-shell.\n\n\nMore Information\n================\n\nBelow are miscellaneous links for more information:\n\n* `AWS CLI Reference Docs`_\n* `AWS CLI User Guide`_\n* `AWS CLI Blog`_\n* `AWS CLI Github Repo`_\n\n.. _pip: http://www.pip-installer.org/en/latest/\n.. _AWS CLI Getting Started Guide: http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html\n.. _boto3: https://github.com/boto/boto3\n.. _AWS CLI Reference Docs: http://docs.aws.amazon.com/cli/latest/reference/\n.. _AWS CLI User Guide: http://docs.aws.amazon.com/cli/latest/userguide/\n.. _AWS CLI Blog: https://blogs.aws.amazon.com/cli/\n.. _AWS CLI Github Repo: https://github.com/aws/aws-cli\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/awslabs/aws-shell", "keywords": "", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "aws-shell", "package_url": "https://pypi.org/project/aws-shell/", "platform": "", "project_url": "https://pypi.org/project/aws-shell/", "project_urls": { "Homepage": "https://github.com/awslabs/aws-shell" }, "release_url": "https://pypi.org/project/aws-shell/0.2.1/", "requires_dist": [ "Pygments (>=2.1.3,<3.0.0)", "awscli (<2.0.0,>=1.16.10)", "boto3 (<2.0.0,>=1.9.0)", "configobj (>=5.0.6,<6.0.0)", "prompt-toolkit (<1.1.0,>=1.0.0)" ], "requires_python": "", "summary": "AWS Shell", "version": "0.2.1" }, "last_serial": 4298308, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "cc8cd058bced2765613d6773d65cdb50", "sha256": "d66d6ec270d9138b6e7322753dd99c332b6f5746007e20ceb2cc768527674671" }, "downloads": -1, "filename": "aws-shell-0.0.1.tar.gz", "has_sig": false, "md5_digest": "cc8cd058bced2765613d6773d65cdb50", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 45861, "upload_time": "2015-12-15T22:26:25", "url": "https://files.pythonhosted.org/packages/58/d6/c68385f5195873081ad42c260d07dda85b14c37f37bf7c2341d1baa92bdf/aws-shell-0.0.1.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "840856f74cf562f6702561203eca3864", "sha256": "2d89e3c51e6cf7da74c8bca8b8a986cc8edcad27ccd6c15678cd84b970f63a16" }, "downloads": -1, "filename": "aws-shell-0.1.0.tar.gz", "has_sig": false, "md5_digest": "840856f74cf562f6702561203eca3864", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 52453, "upload_time": "2015-12-31T00:00:00", "url": "https://files.pythonhosted.org/packages/f5/0a/fdf676b792626f2d9e0e2297333c6ed6c9be1922a03eea10d243930e33d6/aws-shell-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "174731d8f1aaf7acea6934517a9deb45", "sha256": "653f085d966b4ed3b3581b7bb85f6f0bb1e8a3bfd852a3333596082a5ba689df" }, "downloads": -1, "filename": "aws-shell-0.1.1.tar.gz", "has_sig": false, "md5_digest": "174731d8f1aaf7acea6934517a9deb45", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 53318, "upload_time": "2016-05-21T00:51:58", "url": "https://files.pythonhosted.org/packages/3f/d1/0f5bdb9833f2a57095bc133fa603de8e8931f6ca44653bd56afda8148e0f/aws-shell-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "b76bf6c71c05091045c9ccca6bfb0f4c", "sha256": "65503dfd1ab74fe49ac203416737f8be1d124cf25ce703c71c5f82983ce7dc47" }, "downloads": -1, "filename": "aws_shell-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b76bf6c71c05091045c9ccca6bfb0f4c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 50745, "upload_time": "2017-08-31T17:53:39", "url": "https://files.pythonhosted.org/packages/55/08/497a5a68ae8380aa812ffb782dff9df394fe6dc19861a1ffd13c964f6fbb/aws_shell-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5079098a614b7f5190fbf70cf06806e3", "sha256": "b46a673b81254e5e014297e08c9ecab535773aa651ca33dc3786a1fd612f9810" }, "downloads": -1, "filename": "aws-shell-0.2.0.tar.gz", "has_sig": false, "md5_digest": "5079098a614b7f5190fbf70cf06806e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 93963, "upload_time": "2017-08-31T17:53:41", "url": "https://files.pythonhosted.org/packages/ea/a0/0fba732444bdc23580f5e0290b8a6732b47a934c1978d108407704b01eec/aws-shell-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "30e95178ba2cee30dac624ec0f9be461", "sha256": "d92b1abcba552da89929d23f180a500e708487b98c6c6e7de66faf634126a8eb" }, "downloads": -1, "filename": "aws_shell-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "30e95178ba2cee30dac624ec0f9be461", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 50747, "upload_time": "2018-09-21T23:06:47", "url": "https://files.pythonhosted.org/packages/7b/a9/bc5ce706e632833932969c65d66bccb5ecbb3791d5f911c74d3e205c5d53/aws_shell-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a1314f3970fe816d56489f1fb0dca320", "sha256": "2044b0ef78c7542c392f2cee4b74a4439545c63dda0a3e28b712fff53e8e5823" }, "downloads": -1, "filename": "aws-shell-0.2.1.tar.gz", "has_sig": false, "md5_digest": "a1314f3970fe816d56489f1fb0dca320", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 54922, "upload_time": "2018-09-21T23:06:49", "url": "https://files.pythonhosted.org/packages/46/5a/c01bbff96fcbe8051e0b59e6191e07f5917f7f2cf667557c7dcbb85f62c3/aws-shell-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "30e95178ba2cee30dac624ec0f9be461", "sha256": "d92b1abcba552da89929d23f180a500e708487b98c6c6e7de66faf634126a8eb" }, "downloads": -1, "filename": "aws_shell-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "30e95178ba2cee30dac624ec0f9be461", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 50747, "upload_time": "2018-09-21T23:06:47", "url": "https://files.pythonhosted.org/packages/7b/a9/bc5ce706e632833932969c65d66bccb5ecbb3791d5f911c74d3e205c5d53/aws_shell-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a1314f3970fe816d56489f1fb0dca320", "sha256": "2044b0ef78c7542c392f2cee4b74a4439545c63dda0a3e28b712fff53e8e5823" }, "downloads": -1, "filename": "aws-shell-0.2.1.tar.gz", "has_sig": false, "md5_digest": "a1314f3970fe816d56489f1fb0dca320", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 54922, "upload_time": "2018-09-21T23:06:49", "url": "https://files.pythonhosted.org/packages/46/5a/c01bbff96fcbe8051e0b59e6191e07f5917f7f2cf667557c7dcbb85f62c3/aws-shell-0.2.1.tar.gz" } ] }