Skip to main content

Some AWS CLI commands with a beautiful TUI

Project description

cloudsnake 🐍

Wrapping some useful AWS cli commands to operate some services like EC2, SSO and more


pre-commit GitHub code size in bytes GitHub last commit GitHub issues GitHub pull requests GitHub Repo stars GitHub watchers Python version PyPiP version License Linter PyPip downloads


In your terminal, set the corresponding AWS_PROFILE=MyProfile if not using the default. (~/.aws/credentials). Copy this helper function called aws-profile into your favourite shell (.bashrc, .zshrc, ~/.config/fish/function) to easily switch between AWS profiles. In case of using fish shell, use this other function.



SSM session

aws-profile




SSM session

SSM session

Install the REQUIRED plugin to use SSM sessions.

cloudsnake ssm start-session -is # will print all your instances in a terminal menu
cloudsnake ssm start-session --target i-XXXXXX  # connect to the instance specifying the target id



SSM get parameter

SSM parameter

cloudsnake ssm get-parameter # default region eu-west-1
cloudsnake --region us-east-1 ssm get-parameters # specify region



SSO get-credentials

SSO get-credentials

cloudsnake --region eu-west-1 sso get-credentials --start-url https://myapp.awsapps.com/start

[!NOTE] This command will open your default browser. You will need to approve manually the authentication. More use cases and examples for cloudsnake sso get-credentials can be found in docs/sso-get-credentials.md.




Cloudwatch log stream

Cloudwatch log stream

cloudsnake logs stream
cloudsnake logs stream --filter-pattern "ERROR"

[!NOTE] By the moment, logs stream only supports viewing logs from the moment you start the command. Future versions will include the ability to view historical logs.

Installation

Using pipx (Recommended)

Install pipx with your system package manager (apt, dnf, pacman...).

pipx install cloudsnake

Using pip

pip3 install cloudsnake

[!WARNING] Probably your system will not allow this installation method due to a broken system package.

Example error
Error:

error: externally-managed-environment

× This environment is externally managed ╰─> To install Python packages system-wide, try 'pacman -S python-xyz', where xyz is the package you are trying to install.

If you wish to install a non-Arch-packaged Python package,
create a virtual environment using 'python -m venv path/to/venv'.
Then use path/to/venv/bin/python and path/to/venv/bin/pip.

If you wish to install a non-Arch packaged Python application,
it may be easiest to use 'pipx install xyz', which will manage a
virtual environment for you. Make sure you have python-pipx
installed via pacman.

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. hint: See PEP 668 for the detailed specification.

Upgrade

pipx upgrade cloudsnake

Uninstall

pipx uninstall cloudsnake
# or
pip3 uninstall cloudsnake

Debug AWS SDK API calls

cloudsnake --log-level debug command subcommand [options]

License

cloudsnake is distributed under the terms of the GPL3 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudsnake-0.10.0.tar.gz (35.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cloudsnake-0.10.0-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

Details for the file cloudsnake-0.10.0.tar.gz.

File metadata

  • Download URL: cloudsnake-0.10.0.tar.gz
  • Upload date:
  • Size: 35.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.14.2 Darwin/25.2.0

File hashes

Hashes for cloudsnake-0.10.0.tar.gz
Algorithm Hash digest
SHA256 ba48d86125c97f820c402d6361965af04064aefe563641814e383bfcf6eb304c
MD5 fc05282a88bea6151afb9c4ab44115ed
BLAKE2b-256 ace3b4ce70471154a56db934d8b20ac227940e7d1be92fa0a3b70948849d2fe6

See more details on using hashes here.

File details

Details for the file cloudsnake-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: cloudsnake-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 38.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.14.2 Darwin/25.2.0

File hashes

Hashes for cloudsnake-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1ade181d3a7d64523d0e958d0d353a69a139c70cb5521a341dcd8086b91a3ec
MD5 057ab20ed90f11943487403046354c80
BLAKE2b-256 bb3a32d9cff0341ac9fc9a3d4c58ee1d0ac1a43d74a5f189a7b2da6094bf8c3f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page