1
- AWS Shell - the interactive productivity booster for the AWS CLI
1
+ aws-shell - The interactive productivity booster for the AWS CLI
2
2
================================================================
3
3
4
4
.. 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
7
7
Installation
8
8
============
9
9
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 `_::
11
12
12
13
$ pip install aws-shell
13
14
14
15
If you are not installing into a virtualenv you can run::
15
16
16
17
$ sudo pip install aws-shell
17
18
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 ,
19
20
you can run::
20
21
21
22
$ pip install --upgrade aws-shell
22
23
23
24
You can also use this upgrade command whenever a new version of the AWS CLI is
24
25
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 .
26
27
27
- Once you've installed the AWS Shell , you can now run::
28
+ Once you've installed the aws-shell , you can now run::
28
29
29
30
$ aws-shell
30
31
@@ -33,7 +34,7 @@ To exit the shell, press ``Ctrl-D``.
33
34
Supported Python Versions
34
35
-------------------------
35
36
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:
37
38
38
39
* 2.6.5 and greater
39
40
* 2.7.x and greater
@@ -44,7 +45,7 @@ The AWS Shell works on the same python versions supported by the AWS CLI:
44
45
Configuration
45
46
=============
46
47
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.
48
49
If you've never used the AWS CLI before, the easiest way to get
49
50
started is to run the ``configure `` command::
50
51
@@ -62,7 +63,7 @@ For more information about configure settings, see the
62
63
Basic Usage
63
64
===========
64
65
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
66
67
need to provide the ``aws `` prefix. For example, here are a few commands
67
68
you can try::
68
69
@@ -91,7 +92,7 @@ Features
91
92
Auto Completion of Commands and Options
92
93
---------------------------------------
93
94
94
- The AWS Shell provides auto completion of commands and
95
+ The aws-shell provides auto completion of commands and
95
96
options as you type.
96
97
97
98
@@ -101,7 +102,7 @@ options as you type.
101
102
Shorthand Auto Completion
102
103
-------------------------
103
104
104
- The AWS Shell can also fill in an example of the
105
+ The aws-shell can also fill in an example of the
105
106
shorthand syntax used for various AWS CLI options:
106
107
107
108
.. 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:
110
111
Server Side Auto Completion
111
112
---------------------------
112
113
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
114
115
server side resources such as Amazon EC2 instance Ids, Amazon Dynamodb table
115
116
names, AWS IAM user names, Amazon S3 bucket names, etc.
116
117
@@ -139,7 +140,7 @@ typing. You can try typing:
139
140
Inline Documentation
140
141
--------------------
141
142
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.
143
144
It will show inline documentation for CLI options. There is also a separate
144
145
documentation panel that will show documentation for the current command or
145
146
option you are typing.
@@ -150,15 +151,15 @@ option you are typing.
150
151
Fish-Style Auto Suggestions
151
152
---------------------------
152
153
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
154
155
complete a suggestion.
155
156
156
157
.. image :: https://cloud.githubusercontent.com/assets/368057/11822961/4bceff94-a326-11e5-87fa-c664e1e82be4.png
157
158
158
159
Command History
159
160
---------------
160
161
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
162
163
``~/.aws/shell/history ``. You can use the up and down arrow keys to scroll
163
164
through your history.
164
165
@@ -167,37 +168,37 @@ through your history.
167
168
Toolbar Options
168
169
---------------
169
170
170
- The AWS Shell has a bottom toolbar that provides several options:
171
+ The aws-shell has a bottom toolbar that provides several options:
171
172
172
173
* ``F2 `` toggles between fuzzy and substring matching
173
174
* ``F3 `` toggles between VI and Emacs key bindings
174
175
* ``F4 `` toggles between single and multi column auto completions
175
176
* ``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
177
178
178
179
As you toggle options in the toolbar, your preferences are persisted
179
180
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.
181
182
182
183
.. image :: https://cloud.githubusercontent.com/assets/368057/11823907/8c3f1e60-a32b-11e5-9f99-fe504ea0a5dc.png
183
184
184
185
Dot Commands
185
186
------------
186
187
187
- The AWS Shell provides additional commands specific to the AWS Shell .
188
+ The aws-shell provides additional commands specific to the aws-shell .
188
189
The commands are available by adding the ``. `` prefix before a command.
189
190
190
191
Creating Shell Scripts with .edit
191
192
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
192
193
193
194
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.
195
196
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.
198
199
199
200
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
201
202
variable before defaulting to ``notepad `` on Windows and
202
203
``vim `` on other platforms.
203
204
@@ -211,7 +212,7 @@ variable before defaulting to ``notepad`` on Windows and
211
212
Executing Shell Commands
212
213
------------------------
213
214
214
- The AWS Shell integrates with other commands in several ways.
215
+ The aws-shell integrates with other commands in several ways.
215
216
First, you can pipe AWS CLI commands to other processes as well
216
217
as redirect output to a file::
217
218
@@ -228,11 +229,11 @@ command, you can add the ``!`` prefix to your command::
228
229
Developer Preview Status
229
230
========================
230
231
231
- The AWS Shell is currently in developer preview.
232
+ The aws-shell is currently in developer preview.
232
233
We welcome feedback, feature requests, and bug reports.
233
234
There may be backwards incompatible changes made in order
234
235
to respond to customer feedback as we continue to iterate
235
- on the AWS Shell .
236
+ on the aws-shell .
236
237
237
238
238
239
More Information
0 commit comments