Installation

Installation

Requirements

• Python 3.11+
• Poetry (recommended installer)
• AWS credentials configured (via ~/.aws/credentials, environment variables, or IAM role)

---

Install via Poetry (Recommended)

Clone the repository and run from the SSM/ directory:

cd SSM
poetry install
poetry run ssm-explorer install

This registers a global ssm-explorer wrapper so you can run it from any directory:

ssm-explorer --help
ssm-explorer check --profile my_profile_aws --region eu-west-1

PATH Setup

If ~/.local/bin is not on your PATH, add it to your shell profile (.bashrc, .zshrc, etc.):

export PATH="$HOME/.local/bin:$PATH"

Then reload your shell:

source ~/.bashrc   # or ~/.zshrc

---

Install via pipx (Optional)

pipx is also supported as an alternative to Poetry:

pipx install .

---

Verify Installation

Run the built-in check command to validate your install, config, AWS profile, and region:

ssm-explorer check
ssm-explorer check --profile my_profile_aws --region eu-west-1

check is offline by default — it validates your local config, registered CLI commands, local AWS profile names, and known SSM regions without calling AWS APIs.

---

Uninstall

Remove the local wrapper:

ssm-explorer uninstall

This keeps your config file by default. To remove the config too:

ssm-explorer uninstall --remove-config

---

Next Steps

• Configure your profiles and regions
• Explore the Commands reference