Skip to content

Commit 68a444f

Browse files
committed
Merge branch 'master' into fix-path-issues
2 parents 7bcf5af + 571d8d4 commit 68a444f

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,24 @@ The code is based on the following article https://docs.aws.amazon.com/IAM/lates
1414

1515
The goal of this plugin is to simplify the authentication process to AWS Console, by providing a method to login to a given account without leaving the terminal.
1616

17-
# Installation & Usage
17+
# Installation
1818
To install it as a plugin for `awscli` please follow these steps
1919

2020
Install `awscli-console-plugin` using `pip`, use an appropriate artifact for your OS from the release page.
2121
```bash
22-
$ pip install https://github.com/b-b3rn4rd/awscli-console-plugin/releases/download/1.0.0/awscli-console-plugin_1.0.0_Darwin_x86_64.zip # MacOS
23-
$ pip install https://github.com/b-b3rn4rd/awscli-console-plugin/releases/download/1.0.0/awscli-console-plugin_1.0.0_Linux_x86_64.zip # Linux
24-
$ pip install https://github.com/b-b3rn4rd/awscli-console-plugin/releases/download/1.0.0/awscli-console-plugin_1.0.0_Windows_x86_64.zip # Windows
22+
$ pip3 install https://github.com/b-b3rn4rd/awscli-console-plugin/releases/download/1.2.0/awscli-console-plugin_1.2.0_Darwin_x86_64.zip # MacOS
23+
$ pip3 install https://github.com/b-b3rn4rd/awscli-console-plugin/releases/download/1.2.0/awscli-console-plugin_1.2.0_Linux_x86_64.zip # Linux
24+
$ pip3 install https://github.com/b-b3rn4rd/awscli-console-plugin/releases/download/1.2.0/awscli-console-plugin_1.2.0_Windows_x86_64.zip # Windows
2525
```
2626

27-
Modify the `plugins` sections in the `~/.aws/config` file
28-
```bash
27+
28+
# Configuration
29+
30+
Edit your `~/.aws/config` to include the following plugin definition:
31+
32+
If you are using the v1 AWS CLI, you can just add the plugin:
33+
34+
```
2935
[plugins]
3036
console = console
3137
@@ -39,6 +45,26 @@ region=ap-southeast-2
3945
source_profile=auth
4046
```
4147

48+
If you are using the v2 AWS CLI, you need to also specify the `cli_legacy_plugin_path`, which should
49+
specify where your `pip` packages are installed.
50+
51+
```
52+
[plugins]
53+
cli_legacy_plugin_path = <path to your python3.7/site-packages>
54+
console = console
55+
56+
[profile auth]
57+
region=ap-southeast-2
58+
aws_access_key_id=AKIAXXXXXXXXXXX
59+
aws_secret_access_key=XYXYXYYXYXYXYXYXY/ZZZZZZ
60+
[profile dev]
61+
role_arn=arn:aws:iam::1234567890123:role/OrganizationAccountAccessRole
62+
region=ap-southeast-2
63+
source_profile=auth
64+
```
65+
66+
# Usage
67+
4268
Verify that the plugin is successfully installed
4369
```bash
4470
$ aws console help
@@ -66,4 +92,4 @@ OPTIONS
6692
Usage Example
6793
```bash
6894
aws console --profile dev
69-
```
95+
```

0 commit comments

Comments
 (0)