saws 0.4.2

SAWS: A Supercharged AWS Command Line Interface (CLI)


SAWS

[](https://travis-ci.org/donnemartin/saws) [](http://saws.readthedocs.org/en/latest/?badge=latest) [](https://gemnasium.com/donnemartin/saws)

[](http://badge.fury.io/py/saws) [](https://pypi.python.org/pypi/saws/) [](http://www.apache.org/licenses/LICENSE-2.0.html)

## Motivation

### AWS CLI

Although the [AWS CLI](https://github.com/aws/aws-cli) is a great resource to manage your AWS-powered services, it’s tough to remember usage of:

• 70+ top-level commands

• 2000+ subcommands

• Countless command-specific options

• Resources such as instance tags and buckets

### SAWS: A Supercharged AWS CLI

SAWS aims to supercharge the AWS CLI with features focusing on:

• Improving ease-of-use

• Increasing productivity

Under the hood, SAWS is powered by the AWS CLI and supports the same commands and command structure.

SAWS and AWS CLI Usage:

aws <command> <subcommand> [parameters] [options]

SAWS features:

• Auto-completion of:

  • Commands

  • Subcommands

  • Options

• Auto-completion of resources:

  • Bucket names

  • Instance ids

  • Instance tags

  • [More coming soon!](#todo-add-more-resources)

• Customizable shortcuts

• Fuzzy completion of resources and shortcuts

• Fish-style auto-suggestions

• Syntax and output highlighting

• Execution of shell commands

• Command history

• Contextual help

• Toolbar options

SAWS is available for Mac, Linux, Unix, and [Windows](#windows-support).


## Index

### Features

• [Syntax and Output Highlighting](#syntax-and-output-highlighting)

• [Auto-Completion of Commands, Subcommands, and Options](#auto-completion-of-commands-subcommands-and-options)

• [Auto-Completion of AWS Resources](#auto-completion-of-aws-resources)

  • [S3 Buckets](#s3-buckets)

  • [EC2 Instance Ids](#ec2-instance-ids)

  • [EC2 Instance Tags](#ec2-instance-tags)

  • [TODO: Add More Resources](#todo-add-more-resources)

• [Customizable Shortcuts](#customizable-shortcuts)

• [Fuzzy Resource and Shortcut Completion](#fuzzy-resource-and-shortcut-completion)

• [Fish-Style Auto-Suggestions](#fish-style-auto-suggestions)

• [Executing Shell Commands](#executing-shell-commands)

• [Command History](#command-history)

• [Contextual Help](#contextual-help)

  • [Contextual Command Line Help](#contextual-command-line-help)

  • [Contextual Web Docs](#contextual-web-docs)

• [Toolbar Options](#toolbar-options)

• [Windows Support](#windows-support)

### Installation and Tests

• [Installation](#installation)

  • [Pip Installation](#pip-installation)

  • [Virtual Environment and Docker Installation](#virtual-environment-and-docker-installation)

  • [AWS Credentials and Named Profiles](#aws-credentials-and-named-profiles)

  • [Supported Python Versions](#supported-python-versions)

  • [Supported Platforms](#supported-platforms)

• [Developer Installation](#developer-installation)

  • [Continuous Integration](#continuous-integration)

  • [Dependencies Management](#dependencies-management)

  • [Unit Tests and Code Coverage](#unit-tests-and-code-coverage)

  • [Documentation](#documentation)

### Misc

• [Contributing](#contributing)

• [Credits](#credits)

• [Contact Info](#contact-info)

• [License](#license)

## Syntax and Output Highlighting


You can control which theme to load for syntax highlighting by updating your [~/.sawsrc](https://github.com/donnemartin/saws/blob/master/saws/sawsrc) file:

` # Visual theme. Possible values: manni, igor, xcode, vim, autumn, vs, rrt, # native, perldoc, borland, tango, emacs, friendly, monokai, paraiso-dark, # colorful, murphy, bw, pastie, paraiso-light, trac, default, fruity theme = vim `

## Auto-Completion of Commands, Subcommands, and Options

SAWS provides smart autocompletion as you type. Entering the following command will interactively list and auto-complete all subcommands specific only to ec2:

aws ec2


## Auto-Completion of AWS Resources

In addition to the default commands, subcommands, and options the AWS CLI provides, SAWS supports auto-completion of your AWS resources. Currently, bucket names, instance ids, and instance tags are included, with additional support for more resources [under development](#todo-add-more-resources).

### S3 Buckets

Option for s3api:

–bucket

Sample Usage:

aws s3api get-bucket-acl –bucket

Syntax for s3:

s3://

Sample Usage:

aws s3 ls s3://

Note: The example below demonstrates the use of [fuzzy resource completion](fuzzy-resource-and-shortcutcompletion):


### EC2 Instance Ids

Option for ec2:

–instance-ids

Sample Usage:

aws ec2 describe-instances –instance-ids aws ec2 ls –instance-ids

Note: The ls command demonstrates the use of [customizable shortcuts](#customizable-shortcuts):


### EC2 Instance Tags

Option for ec2:

–ec2-tag-key –ec2-tag-value

Sample Usage:

aws ec2 ls –ec2-tag-key aws ec2 ls –ec2-tag-value

Tags support wildcards with the * character.

Note: ls, –ec2-tag-value, and –ec2-tag-key demonstrate the use of [customizable shortcuts](#customizable-shortcuts):


### TODO: Add More Resources

Feel free to [submit an issue or a pull request](#contributions) if you’d like support for additional resources.

## Customizable Shortcuts

The [~/.saws.shortcuts](https://github.com/donnemartin/saws/blob/master/saws/saws.shortcuts) file contains shortcuts that you can modify. It comes pre-populated with several [handy shortcuts](https://github.com/donnemartin/saws/blob/master/saws/saws.shortcuts) out of the box. You can combine shortcuts with [fuzzy completion](#fuzzy-resource-and-shortcut-completion) for even less keystrokes. Below are a few examples.

List all EC2 instances:

aws ec2 ls

List all running EC2 instances:

aws ec2 ls –ec2-state running # fuzzy shortcut: aws ecstate


List all EC2 instances with a matching tag (supports wildcards *):

aws ec2 ls –ec2-tag-key # fuzzy shortcut: aws ectagk aws ec2 ls –ec2-tag-value # fuzzy shortcut: aws ectagv


List EC2 instance with matching id:

aws ec2 ls –instance-ids # fuzzy shortcut: aws eclsi


List all DynamoDB tables:

aws dynamodb ls # fuzzy shortcut: aws dls

List all EMR clusters:

aws emr ls # fuzzy shortcut: aws emls

Add/remove/modify shortcuts in your [~/.saws.shortcuts](https://github.com/donnemartin/saws/blob/master/saws/shortcuts) file to suit your needs.

Feel free to submit:

• An issue to request additional shortcuts

• A pull request if you’d like to share your shortcuts (see [contributing guidelines](#contributions))

### Fuzzy Resource and Shortcut Completion

To toggle fuzzy completion of AWS resources and shortcuts, use F3 key.

Sample fuzzy shortcuts to start and stop EC2 instances:

aws ecstop aws ecstart

Note: Fuzzy completion currently only works with AWS [resources](#auto-completion-of-aws-resources) and [shortcuts](customizable-shortcuts).


## Fish-Style Auto-Suggestions

SAWS supports Fish-style auto-suggestions. Use the right arrow key to complete a suggestion.


## Executing Shell Commands

SAWS allows you to execute shell commands from the saws> prompt.


## Command History

SAWS keeps track of commands you enter and stores them in ~/.saws-history. Use the up and down arrow keys to cycle through the command history.


## Contextual Help

SAWS supports contextual command line help and contextual web docs.

### Contextual Command Line Help

The help command is powered by the AWS CLI and outputs help within the command line.

Usage:

aws <command> <subcommand> help


### Contextual Web Docs

Sometimes you’re not quite sure what specific command/subcommand/option combination you need to use. In such cases, browsing through several combinations with the help command line is cumbersome versus browsing the online AWS CLI docs through a web browser.

SAWS supports contextual web docs with the docs command or the F9 key. SAWS will display the web docs specific to the currently entered command and subcommand.

Usage:

aws <command> <subcommand> docs


## Toolbar Options

SAWS supports a number of toolbar options:

• F2 toggles [output syntax highlighting](#syntax-and-output-highlighting)

• F3 toggles [fuzzy completion of AWS resources and shortcuts](#fuzzy-resource-and-shortcut-completion)

• F4 toggles [completion of shortcuts](#customizable-shortcuts)

• F5 refreshes [resources for auto-completion](#auto-completion-of-aws-resources)

• F9 displays the [contextual web docs](#contextual-web-docs)

• F10 or control d exits SAWS


## Windows Support

SAWS has been tested on Windows 7 and Windows 10.

On Windows, the [.sawsrc](https://github.com/donnemartin/saws/blob/master/saws/sawsrc) file can be found in %userprofile%. For example:

C:Usersdmartin.sawsrc

Although you can use the standard Windows command prompt, you’ll probably have a better experience with either [cmder](https://github.com/cmderdev/cmder) or [conemu](https://github.com/Maximus5/ConEmu).


## Installation

### Pip Installation

[](http://badge.fury.io/py/saws) [](https://pypi.python.org/pypi/saws/)

SAWS is hosted on [PyPI](https://pypi.python.org/pypi/saws). The following command will install SAWS along with dependencies such as the [AWS CLI](https://github.com/aws/aws-cli):

$ pip install saws

You can also install the latest SAWS from GitHub source which can contain changes not yet pushed to PyPI:

$ pip install git+https://github.com/donnemartin/saws.git

If you are not installing in a [virtualenv](#virtual-environment-and-docker-installation), run with sudo:

$ sudo pip install saws

Once installed, start SAWS:

$ saws

### Virtual Environment and Docker Installation

It is recommended that you install Python packages in a [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/) to avoid potential [issues with dependencies or permissions](https://github.com/donnemartin/saws/issues/15).

To view SAWS virtualenv and [Docker](https://www.docker.com/) installation instructions, click [here](https://github.com/donnemartin/saws/blob/master/INSTALLATION.md).

### Mac OS X 10.11 El Capitan Users

There is a known issue with Apple and its included python package dependencies (more info at https://github.com/pypa/pip/issues/3165). We are investigating ways to fix this issue but in the meantime, to install saws, you can run:

$ sudo pip install saws –upgrade –ignore-installed six

### AWS Credentials and Named Profiles

[Configure your credentials](https://github.com/aws/aws-cli#getting-started) with the AWS CLI:

$ aws configure

If you’d like to use a specific named profile with SAWS, run the following commands on OS X, Linux, or Unix:

$ export AWS_DEFAULT_PROFILE=user1 $ saws

Or as a one-liner:

$ AWS_DEFAULT_PROFILE=user1 saws

Windows users can run the following commands:

> set AWS_DEFAULT_PROFILE=user1 > saws

Command line options for starting SAWS with a specific profile are [under development](https://github.com/donnemartin/saws/issues/16). For more details on how to install and configure the AWS CLI, refer to the following [documentation](http://docs.aws.amazon.com/cli/latest/userguide/installing.html).

### Supported Python Versions

• Python 2.6

• Python 2.7

• Python 3.3

• Python 3.4

• Pypy

Light testing indicates that SAWS also seems to be compatible with Python 3.5.

Pypy3 is not supported due to [lack of support](https://github.com/boto/botocore/issues/622) from [boto](https://github.com/boto/boto).

### Supported Platforms

• Mac OS X

  • Tested on OS X 10.10

• Linux, Unix

  • Tested on Ubuntu 14.04 LTS

• Windows

  • Tested on Windows 7 and 10

## Developer Installation

If you’re interested in contributing to SAWS, run the following commands:

$ git clone https://github.com/donnemartin/saws.git $ pip install -e . $ pip install -r requirements-dev.txt $ saws

### Continuous Integration

[](https://travis-ci.org/donnemartin/saws)

Continuous integration details are available on [Travis CI](https://travis-ci.org/donnemartin/saws).

### Dependencies Management

[](https://gemnasium.com/donnemartin/saws)

Dependencies management details are available on [Gemnasium](https://gemnasium.com/donnemartin/saws).

### Unit Tests and Code Coverage

Run unit tests in your active Python environment:

$ python tests/run_tests.py

Run unit tests with [tox](https://pypi.python.org/pypi/tox) on multiple Python environments:

$ tox

### Documentation

[](http://saws.readthedocs.org/en/latest/?badge=latest)

Source code documentation is available on [Readthedocs.org](http://saws.readthedocs.org/en/latest/?badge=latest).

Run the following to build the docs:

$ scripts/update_docs.sh

## Contributing

Contributions are welcome!

Review the [Contributing Guidelines](https://github.com/donnemartin/saws/blob/master/CONTRIBUTING.md) for details on how to:

• Submit issues

• Submit pull requests

## Credits

• [AWS CLI](https://github.com/aws/aws-cli) by [AWS](https://github.com/aws) for powering SAWS under the hood

• [Python Prompt Toolkit](https://github.com/jonathanslenders/python-prompt-toolkit) by [jonathanslenders](https://github.com/jonathanslenders) for simplifying the creation of SAWS

• [Wharfee](https://github.com/j-bennet/wharfee) by [j-bennet](https://github.com/j-bennet) for inspiring the creation of SAWS and for some handy utility functions

## Contact Info

Feel free to contact me to discuss any issues, questions, or comments.

• Email: [[e-mail]](mailto:[e-mail])

• Twitter: [donne_martin](https://twitter.com/donne_martin)

• GitHub: [donnemartin](https://github.com/donnemartin)

• LinkedIn: [donnemartin](https://www.linkedin.com/in/donnemartin)

• Website: [donnemartin.com](http://donnemartin.com)

## License

Copyright 2015 Donne Martin

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.