Skip to content

v1.1.0

Choose a tag to compare

@ditahm6 ditahm6 released this 21 Jan 01:16
· 371 commits to main since this release
f687218

Release Notes: Version 1.1.0 (First Release)

Overview

This is the first official release of quickssm, a streamlined CLI tool for managing AWS SSM Session Manager connections. The tool simplifies listing and connecting to EC2 instances across multiple AWS regions using short region codes.


Key Features

  • Quick connection to EC2 instances via AWS SSM Session Manager.
  • Interactive listing of running EC2 instances in supported regions.
  • Region shortcodes for faster navigation (e.g., cac1, use1).
  • Automatic validation of AWS CLI and Session Manager plugin installation.
  • Interactive installation for the AWS Session Manager plugin if missing.
  • Support for multiple AWS regions with color-coded output for readability.

Setup Instructions

  1. Clone the repository:

    git clone https://github.com/ZSoftly/quickssm.git
    cd quickssm
  2. Make the script executable:

    chmod +x ssm
  3. Add the script to your PATH:

    • For Bash:
      echo "export PATH=\"\$PATH:$(pwd)\"" >> ~/.bashrc
      source ~/.bashrc
    • For Zsh:
      echo "export PATH=\"\$PATH:$(pwd)\"" >> ~/.zshrc
      source ~/.zshrc
  4. Verify the installation:

    ssm check

Usage Examples

  • List EC2 instances in a region:
    ssm cac1
  • Connect to an instance in the default region:
    ssm i-1234abcd
  • Connect to an instance in a specific region:
    ssm use1 i-1234abcd

Supported Regions

Shortcode AWS Region Location
cac1 ca-central-1 Montreal
caw1 ca-west-1 Calgary
use1 us-east-1 N. Virginia
usw1 us-west-1 N. California
euw1 eu-west-1 Ireland

Known Limitations

  • Limited support for AWS regions (can be expanded in future updates).
  • Requires proper IAM permissions for SSM Session Manager.
  • Currently requires manual addition to PATH after installation.

Future Plans

  • Add support for more AWS regions.
  • Enhance validation checks and error messages.
  • Include pre-built binaries in future releases for easier installation.