Skip to content

Commit 5d42dfd

Browse files
committed
Incorporate review feedback
1 parent 02395d8 commit 5d42dfd

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

README.rst

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
AWS Shell - the interactive productivity booster for the AWS CLI
1+
aws-shell - The interactive productivity booster for the AWS CLI
22
================================================================
33

44
.. 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
@@ -7,24 +7,25 @@ AWS Shell - the interactive productivity booster for the AWS CLI
77
Installation
88
============
99

10-
You can install the AWS Shell using `pip`_::
10+
The aws-shell requires python and `pip`_ to install.
11+
You can install the aws-shell using `pip`_::
1112

1213
$ pip install aws-shell
1314

1415
If you are not installing into a virtualenv you can run::
1516

1617
$ sudo pip install aws-shell
1718

18-
If you want to upgrade to the latest version of the AWS Shell,
19+
If you want to upgrade to the latest version of the aws-shell,
1920
you can run::
2021

2122
$ pip install --upgrade aws-shell
2223

2324
You can also use this upgrade command whenever a new version of the AWS CLI is
2425
released that includes new services and API updates. You will then be
25-
able to use these new services and API updates in the AWS Shell.
26+
able to use these new services and API updates in the aws-shell.
2627

27-
Once you've installed the AWS Shell, you can now run::
28+
Once you've installed the aws-shell, you can now run::
2829

2930
$ aws-shell
3031

@@ -33,7 +34,7 @@ To exit the shell, press ``Ctrl-D``.
3334
Supported Python Versions
3435
-------------------------
3536

36-
The AWS Shell works on the same python versions supported by the AWS CLI:
37+
The aws-shell works on the same python versions supported by the AWS CLI:
3738

3839
* 2.6.5 and greater
3940
* 2.7.x and greater
@@ -44,7 +45,7 @@ The AWS Shell works on the same python versions supported by the AWS CLI:
4445
Configuration
4546
=============
4647

47-
The AWS Shell uses the same configuration settings as the AWS CLI.
48+
The aws-shell uses the same configuration settings as the AWS CLI.
4849
If you've never used the AWS CLI before, the easiest way to get
4950
started is to run the ``configure`` command::
5051

@@ -62,7 +63,7 @@ For more information about configure settings, see the
6263
Basic Usage
6364
===========
6465

65-
The AWS Shell accepts the same commands as the AWS CLI, except you don't
66+
The aws-shell accepts the same commands as the AWS CLI, except you don't
6667
need to provide the ``aws`` prefix. For example, here are a few commands
6768
you can try::
6869

@@ -91,7 +92,7 @@ Features
9192
Auto Completion of Commands and Options
9293
---------------------------------------
9394

94-
The AWS Shell provides auto completion of commands and
95+
The aws-shell provides auto completion of commands and
9596
options as you type.
9697

9798

@@ -101,7 +102,7 @@ options as you type.
101102
Shorthand Auto Completion
102103
-------------------------
103104

104-
The AWS Shell can also fill in an example of the
105+
The aws-shell can also fill in an example of the
105106
shorthand syntax used for various AWS CLI options:
106107

107108
.. image:: https://cloud.githubusercontent.com/assets/368057/11823453/e95d85da-a328-11e5-8b8d-67566eccf9e3.png
@@ -110,7 +111,7 @@ shorthand syntax used for various AWS CLI options:
110111
Server Side Auto Completion
111112
---------------------------
112113

113-
The AWS Shell also leverages `boto3`_, the AWS SDK for Python, to auto complete
114+
The aws-shell also leverages `boto3`_, the AWS SDK for Python, to auto complete
114115
server side resources such as Amazon EC2 instance Ids, Amazon Dynamodb table
115116
names, AWS IAM user names, Amazon S3 bucket names, etc.
116117

@@ -139,7 +140,7 @@ typing. You can try typing:
139140
Inline Documentation
140141
--------------------
141142

142-
The AWS Shell will automatically pull up documentation as you type commands.
143+
The aws-shell will automatically pull up documentation as you type commands.
143144
It will show inline documentation for CLI options. There is also a separate
144145
documentation panel that will show documentation for the current command or
145146
option you are typing.
@@ -150,15 +151,15 @@ option you are typing.
150151
Fish-Style Auto Suggestions
151152
---------------------------
152153

153-
The AWS Shell supports Fish-style auto-suggestions. Use the right arrow key to
154+
The aws-shell supports Fish-style auto-suggestions. Use the right arrow key to
154155
complete a suggestion.
155156

156157
.. image:: https://cloud.githubusercontent.com/assets/368057/11822961/4bceff94-a326-11e5-87fa-c664e1e82be4.png
157158

158159
Command History
159160
---------------
160161

161-
The AWS Shell records the commands you run and writes them to
162+
The aws-shell records the commands you run and writes them to
162163
``~/.aws/shell/history``. You can use the up and down arrow keys to scroll
163164
through your history.
164165

@@ -167,37 +168,37 @@ through your history.
167168
Toolbar Options
168169
---------------
169170

170-
The AWS Shell has a bottom toolbar that provides several options:
171+
The aws-shell has a bottom toolbar that provides several options:
171172

172173
* ``F2`` toggles between fuzzy and substring matching
173174
* ``F3`` toggles between VI and Emacs key bindings
174175
* ``F4`` toggles between single and multi column auto completions
175176
* ``F5`` shows and hides the help documentation pane
176-
* ``F10`` or ``Ctrl-D`` exits the AWS Shell
177+
* ``F10`` or ``Ctrl-D`` exits the aws-shell
177178

178179
As you toggle options in the toolbar, your preferences are persisted
179180
to the ``~/.aws/shell/awsshellrc`` file so that the next time you run
180-
the AWS Shell, your preferences will be restored.
181+
the aws-shell, your preferences will be restored.
181182

182183
.. image:: https://cloud.githubusercontent.com/assets/368057/11823907/8c3f1e60-a32b-11e5-9f99-fe504ea0a5dc.png
183184

184185
Dot Commands
185186
------------
186187

187-
The AWS Shell provides additional commands specific to the AWS Shell.
188+
The aws-shell provides additional commands specific to the aws-shell.
188189
The commands are available by adding the ``.`` prefix before a command.
189190

190191
Creating Shell Scripts with .edit
191192
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
192193

193194
There are times when you may want to take a sequence of commands
194-
you've run in the AWS Shell and combine them into a shell script.
195+
you've run in the aws-shell and combine them into a shell script.
195196
In addition to the command history that's persisted to the
196-
history file, the AWS Shell also keeps track of all the commands
197-
you've run since you first started your AWS Shell session.
197+
history file, the aws-shell also keeps track of all the commands
198+
you've run since you first started your aws-shell session.
198199

199200
You can run the ``.edit`` command to open all these commands in
200-
an editor. The AWS Shell will use the ``EDITOR`` environment
201+
an editor. The aws-shell will use the ``EDITOR`` environment
201202
variable before defaulting to ``notepad`` on Windows and
202203
``vim`` on other platforms.
203204

@@ -211,7 +212,7 @@ variable before defaulting to ``notepad`` on Windows and
211212
Executing Shell Commands
212213
------------------------
213214

214-
The AWS Shell integrates with other commands in several ways.
215+
The aws-shell integrates with other commands in several ways.
215216
First, you can pipe AWS CLI commands to other processes as well
216217
as redirect output to a file::
217218

@@ -228,11 +229,11 @@ command, you can add the ``!`` prefix to your command::
228229
Developer Preview Status
229230
========================
230231

231-
The AWS Shell is currently in developer preview.
232+
The aws-shell is currently in developer preview.
232233
We welcome feedback, feature requests, and bug reports.
233234
There may be backwards incompatible changes made in order
234235
to respond to customer feedback as we continue to iterate
235-
on the AWS Shell.
236+
on the aws-shell.
236237

237238

238239
More Information

0 commit comments

Comments
 (0)