Skip to content

Commit a42a202

Browse files
docs: update README.md and examples
1 parent 290ed63 commit a42a202

File tree

3 files changed

+17
-27
lines changed

3 files changed

+17
-27
lines changed

README.md

Lines changed: 17 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55

66
---
77

8-
![example gif](./example.gif)
9-
10-
---
11-
128
<p align="center" >
139
<img alt="pre-commit" src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white">
1410
<img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/containerscrew/cloudsnake">
@@ -25,27 +21,28 @@
2521

2622
---
2723

28-
# Available implementations
29-
30-
* Connect to EC2 instances using SSM. You can pass the instance id (`--target`) or use the interactive menu (`--with-instance-selector`)
31-
* (In progress) Connect to RDS instances using IAM authentication db token
32-
33-
# Examples
34-
35-
For the examples, you need to be authenticated to AWS account using your local credentials.
24+
<p align="center">
25+
<img align="center" alt="SSM session" src="docs/img//cloudsnake-ssm-session.gif">
26+
<h3 align="center">SSM session</h3>
27+
</p>
3628

3729
In your terminal, set the corresponding `AWS_PROFILE=MyProfile` if not using the default. (`~/.aws/credentials`)
3830

39-
## Connect to the EC2 instance using SSM
40-
4131
```shell
4232
cloudsnake ssm start-session -is # will print all your instances in a terminal menu
4333
cloudsnake ssm start-session --target i-XXXXXX # connect to the instance specifying the target id
4434
```
45-
---
4635

4736
# Installation
4837

38+
## Using pipx (Recommended)
39+
40+
Install `pipx` with your system package manager (`apt`, `dnf`, `pacman`...).
41+
42+
```console
43+
pipx install cloudsnake
44+
```
45+
4946
## Using pip
5047

5148
```console
@@ -65,8 +62,8 @@ error: externally-managed-environment
6562

6663
× This environment is externally managed
6764
╰─> To install Python packages system-wide, try 'pacman -S
68-
python-xyz', where xyz is the package you are trying to
69-
install.
65+
python-xyz', where xyz is the package you are trying to
66+
install.
7067

7168
If you wish to install a non-Arch-packaged Python package,
7269
create a virtual environment using 'python -m venv path/to/venv'.
@@ -79,23 +76,16 @@ error: externally-managed-environment
7976

8077
note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
8178
hint: See PEP 668 for the detailed specification.
79+
8280
</pre>
8381
</details>
8482

85-
## Using pipx (Recommended)
86-
87-
Install `pipx` with your system package manager (`apt`, `dnf`, `pacman`...).
88-
89-
```console
90-
pipx install cloudsnake
91-
```
92-
9383
# Uninstall
9484

9585
```console
96-
pip3 uninstall cloudsnake
97-
# or
9886
pipx uninstall cloudsnake
87+
# or
88+
pip3 uninstall cloudsnake
9989
```
10090

10191
# License
43.7 KB
Loading

example.gif

-1.99 MB
Binary file not shown.

0 commit comments

Comments
 (0)