Skip to main content

Interactive CLI to connect to AWS EC2 and RDS via SSM or SSH-over-SSM, with credential persistence and multi-session support.

Project description

ssm-connect

Interactive CLI to connect to AWS EC2 instances and RDS databases via:

  • SSM Session Manager (interactive shell)
  • SSH over SSM (with your SSH key)
  • RDS Port Forwarding (via EC2 bastion host)
  • File Transfer (SCP) (Securely upload/download files)

Multiple sessions in parallel (each opens in a new terminal). Keyword search across Name, Instance ID, and all tag values. Simple, cross-platform, and secure-by-default.

Features

  • Target Selection: Choose to connect to EC2 instances or RDS databases
  • EC2 Connections:
    • SSM Session Manager (interactive shell)
    • SSH over SSM (with private key authentication)
    • SSH ProxyJump (Connect to target host via bastion)
  • RDS Connections:
    • Port forwarding to RDS databases via EC2 bastion host
    • Auto-selects available local port
  • File Transfer:
    • Upload/Download files to/from EC2 instances using SCP
    • Uses existing SSH key configuration
  • Smart Search: Filter instances by keywords (matches Name, InstanceId, and all tag values)
  • Multi-Session: Opens each connection in a new terminal window (Linux, macOS, Windows) allowing for multiple simultaneous sessions.
  • AWS Session: Automatically inherits AWS credentials
  • Security: Automated scanning via CodeQL, Gitleaks and Pip-Audit on every PR

Install

Latest release from PyPI: pip install --upgrade ssm-connect

Run the tool: ssm-connect

Requirements

  • User should already be logged in to AWS
  • AWS CLI v2
  • SSM Session Manager plugin (installation guide)
  • OpenSSH client (ssh command) - for SSH over SSM
  • Python 3.8+
  • Appropriate IAM role
  • SSH Agent (optional but recommended): Ensure ssh-agent is running to avoid repeated passphrase prompts.

Terminal Apps

The tool automatically detects and uses available terminal emulators:

  • Windows: Windows Terminal (wt), PowerShell, or cmd
  • macOS: Terminal.app
  • Linux: gnome-terminal, konsole, xterm, or x-terminal-emulator

Usage

Start the CLI: ssm-connect

Connection Flow

  1. Choose Target Type:

    • [1] EC2 - Connect directly to an EC2 instance
    • [2] RDS - Forward port to an RDS database via bastion
    • [3] File Transfer - Securely upload/download files
    • [4] Favorites - Quick connect to saved aliases
  2. For EC2 Connections:

    • Choose connection type:
      • [1] SSM - Interactive shell via Session Manager
      • [2] SSH over SSM - SSH session with your private key
      • [3] SSH ProxyJump - Connect to remote host via this instance
    • Filter and select target EC2 instance
    • For SSH: Provide private key path and username
  3. For RDS Connections:

    • Step 1: Select EC2 bastion instance (must have SSM access)
    • Step 2: Select target RDS database
    • Connect to localhost:[auto-selected-port] with your database client
  4. For File Transfer (SCP):

    • Select remote instance
    • Choose direction (Upload / Download)
    • Specify local and remote file paths
    • Tool handles the secure copy tunneling
  5. Favorites & Aliases:

    • Save: After any connection, answer y to "Save this connection as a favorite?"
    • Connect:
      • Select [4] Favorites from menu, OR
      • Use CLI: ssm-connect -f <alias> (e.g., ssm-connect -f prod-db)

Troubleshooting

Command not found

Ensure aws, session-manager-plugin, and ssh are installed and on PATH.

SSO expired

Refresh your AWS SSO session: aws sso login --profile your-profile

SSH key errors

Ensure the key exists and has proper permissions

No terminal found (Linux)

Install a terminal emulator

RDS connection refused

Ensure:

  • The bastion EC2 instance has network connectivity to the RDS
  • The bastion is running
  • You have the appropriate role

Uninstall

pip uninstall ssm-connect

Security

Automated Security Checks

All pull requests and merges undergo automated security analysis to ensure code quality and safety:

  • CodeQL: Static code analysis for security vulnerabilities and unsafe coding patterns.
  • Gitleaks: Scans for hardcoded secrets and credentials to prevent leaks.
  • Pip-Audit: Scans Python dependencies for known security vulnerabilities.

Reporting Security Issues

If you discover a security vulnerability, please report it privately via GitHub's Security Advisory feature rather than opening a public issue.

Contributing

Issues and pull requests are welcome. Please keep changes focused and include brief notes if behavior changes.

License

Apache License 2.0. See LICENSE for details.

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

ssm_connect-1.4.0.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

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

ssm_connect-1.4.0-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file ssm_connect-1.4.0.tar.gz.

File metadata

  • Download URL: ssm_connect-1.4.0.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ssm_connect-1.4.0.tar.gz
Algorithm Hash digest
SHA256 36f516f042850ae718e7c2b588220629d70ddf941ff76d24116b0fa63fea113d
MD5 472a4eb1d77258243b991d7c621bf33a
BLAKE2b-256 ae2e480d303782ccba5b4a65f058992ac2b743299441e33e99c3580287f60b7b

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssm_connect-1.4.0.tar.gz:

Publisher: publish.yml on JoseSiby/ssm-connect

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ssm_connect-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: ssm_connect-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ssm_connect-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67e69b92925ed212865165af30cee687bd5609bf9194853301e58a12abcb3c48
MD5 d4986ed88e940d3ad1f02dfdec2c3496
BLAKE2b-256 b0843db4ad0172c4edaf39d231493e1706d6e4d44d393e2493a6d29d75585cfb

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssm_connect-1.4.0-py3-none-any.whl:

Publisher: publish.yml on JoseSiby/ssm-connect

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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