Skip to content

oleksiimorozenko/awsom

BranchesTags

Repository files navigation

awsom

CI Release Crates.io License Rust Version

AWS Organization Manager - The awesome way to manage AWS SSO sessions.

A modern, k9s-inspired Terminal User Interface (TUI) for managing AWS SSO sessions written in Rust.

Features

  • Single SSO Login: Authenticate once, access multiple AWS accounts and roles
  • Interactive TUI: k9s-style interface for managing sessions with visual indicators
  • CLI Commands: Full command-line interface for automation and scripting
  • Session Management: Create, edit, delete, and switch SSO sessions via CLI or TUI
  • Multi-Session Support: Track multiple SSO sessions across different organizations
  • SSM Browser: Browse and connect to EC2 instances via AWS Systems Manager
  • Auto-Refresh: Automatic credential renewal before expiration
  • Status Checking: Programmatic session status for shell automation and scripting
  • Expiry Tracking: Real-time countdown timers for token and credential expiration
  • Profile Management: Create, rename, and manage AWS credential profiles
  • Console Access: One-click federated sign-in to AWS Console in your browser
  • Default Profile: Set and switch default AWS profile easily
  • Profile Export: Export credentials as environment variables or to ~/.aws/credentials
  • Disk Caching: Smart profile caching with automatic invalidation
  • Symbol Compatibility: Works in any terminal with ASCII fallback mode
  • AWS CLI Compatible: Uses same cache directories and format as AWS CLI v2

No AWS CLI Required!

awsom is a standalone tool that does NOT require the AWS CLI to be installed. It uses the official AWS SDK for Rust to communicate directly with AWS services and manages your ~/.aws/config and ~/.aws/credentials files as plain text.

This means:

  • Faster: No Python runtime or AWS CLI overhead
  • Simpler: One binary, zero dependencies (besides the AWS SDK)
  • Compatible: Works alongside AWS CLI if you have it, but doesn't need it
  • Portable: Easy to install on any system without package managers

If you have existing AWS CLI configurations, awsom will read and respect them. If you don't, awsom will create everything you need from scratch.

SSM Browser

Browse and connect to EC2 instances via AWS Systems Manager:

  • View all EC2 instances across your AWS accounts
  • Filter by name, instance ID, or IP address
  • Sort by name, ID, state, or IP
  • One-key connection to SSM sessions (requires AWS Session Manager Plugin)
  • View instance tags, IP addresses, and real-time status
  • Toggle visibility of offline/stopped instances
  • Real-time search with / key, navigate with arrow keys while searching
  • Tab or Enter to exit search mode, Esc to clear filter

Requirements:

  • AWS Systems Manager Session Manager Plugin must be installed
  • EC2 instances must have SSM Agent installed and running
  • IAM permissions: ssm:StartSession, ec2:DescribeInstances

Installation of Session Manager Plugin:

Installation

Using Cargo (Recommended)

Install from crates.io:

cargo install awsom

Using Homebrew (macOS/Linux)

Linux Prerequisites: On Linux systems, you need to install build-essential before using Homebrew, even though awsom provides pre-built binaries. This is a Homebrew requirement because some of Homebrew's own dependencies may need to be compiled from source:

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install -y build-essential

# Then install awsom
brew install oleksiimorozenko/tap/awsom

macOS:

brew install oleksiimorozenko/tap/awsom

Why build-essential on Linux? Homebrew on Linux requires compiler tools (gcc, make, etc.) to be available on the system. According to the Homebrew on Linux documentation, "Homebrew does not use any libraries provided by your host system, except glibc and gcc if they are new enough." While Homebrew provides pre-compiled binaries (bottles) for most packages, some dependencies will need to be built directly on your machine, which requires a working compiler environment.

The build-essential package provides all the necessary compilation tools including GCC, GNU Make, and other essential development utilities.

Download Pre-built Binaries

Download the latest release for your platform from the releases page:

  • Linux (x86_64): awsom-linux-amd64.tar.gz
  • Linux (ARM64): awsom-linux-arm64.tar.gz
  • macOS (Intel): awsom-macos-amd64.tar.gz
  • macOS (Apple Silicon): awsom-macos-arm64.tar.gz
  • Windows (x86_64): awsom-windows-amd64.zip

After downloading, extract and verify the checksum:

# Example for Linux x86_64
tar xzf awsom-linux-amd64.tar.gz
sha256sum -c awsom-linux-amd64.tar.gz.sha256

# Move to PATH
sudo mv awsom /usr/local/bin/

From Source

git clone https://github.com/oleksiimorozenko/awsom.git
cd awsom
cargo install --path .

Prerequisites

  • Rust 1.70+ (for building from source only)
  • AWS SSO enabled for your organization (no AWS CLI required - awsom handles configuration)

Terminal Symbol Display

awsom uses Unicode symbols (🟢, 🔴, ✓) by default for the best visual experience. These work perfectly in most modern terminals including:

  • Modern Windows Terminal
  • PowerShell 7+
  • Most Linux and macOS terminals (Terminal.app, iTerm2, Alacritty, Kitty, etc.)

If you see broken symbols or boxes (e.g., in cmd.exe, older terminals, or minimal environments), you can enable ASCII mode:

Unix/Linux/macOS:

AWSOM_ASCII_SYMBOLS=true awsom

PowerShell:

$env:AWSOM_ASCII_SYMBOLS="true"
awsom

Windows Command Prompt:

set AWSOM_ASCII_SYMBOLS=true
awsom

Make it permanent:

Unix shells (add to ~/.bashrc, ~/.zshrc, etc.):

export AWSOM_ASCII_SYMBOLS=true

PowerShell (add to profile):

[Environment]::SetEnvironmentVariable("AWSOM_ASCII_SYMBOLS", "true", "User")

With ASCII mode enabled, symbols are displayed as [+], [-], [x], [!] instead of Unicode emojis.

Shell Completion

Enable tab completion for your shell to make the CLI much easier to use:

Bash

# Add to ~/.bashrc or ~/.bash_profile:
eval "$(awsom completions bash)"

# Or save to completion directory:
awsom completions bash | sudo tee /usr/local/etc/bash_completion.d/awsom

Zsh (macOS default)

# Quick setup - add to ~/.zshrc:
eval "$(awsom completions zsh)"

# Or for better performance, save to completion directory:
mkdir -p ~/.zfunc
awsom completions zsh > ~/.zfunc/_awsom

# Then add to ~/.zshrc (if not already there):
fpath=(~/.zfunc $fpath)
autoload -Uz compinit && compinit

Fish

# Save to fish completion directory:
awsom completions fish > ~/.config/fish/completions/awsom.fish

PowerShell

# Add to your PowerShell profile:
awsom completions powershell | Out-String | Invoke-Expression

After setting up completions, you can use Tab to autocomplete commands, options, and values!

Quick Start

1. Login to AWS SSO

awsom session login \
  --start-url https://your-org.awsapps.com/start \
  --region us-east-1

Or set environment variables:

export AWS_SSO_START_URL=https://your-org.awsapps.com/start
export AWS_SSO_REGION=us-east-1
awsom session login

2. List Available Accounts and Roles

# Human-readable format
awsom profile list

# JSON format
awsom profile list --format json

3. Launch TUI

awsom

The TUI provides a k9s-style interactive interface for managing AWS SSO sessions.

Keyboard Shortcuts:

  • q or Esc - Quit application
  • ? or F1 - Show help screen
  • Tab - Switch between Sessions and Profiles panes
  • r - Refresh account/role list
  • ↑/k - Move selection up
  • ↓/j - Move selection down
  • Enter - Start/stop session for selected role (activates or invalidates credentials)
  • a - Add new SSO session (Sessions pane) / Add static credential (Profiles pane)
  • e - Edit profile configuration
  • v - View profile details
  • s - Open SSM Browser (EC2 instance manager)
  • d - Set selected role's profile as default
  • D - Delete selected profile
  • c - Open AWS Console in browser for selected role
  • x - Copy credentials as export commands (Profiles pane only)
  • f - Toggle session filter (Sessions pane only)

In SSM Browser:

  • / - Start search/filter
  • Up/Down or j/k - Navigate instances
  • Enter - Connect to instance via SSM
  • y - Copy SSM command to clipboard
  • s - Cycle sort order (unsorted → name → ID → state → IP)
  • o - Toggle offline instances visibility
  • r - Refresh instance list
  • v - View instance tags
  • Esc or q - Return to main screen

Features:

  • Visual Indicators: 🟢 Active sessions / 🔴 Inactive / ⚠ Incomplete
  • Profile Types: SSO profiles, STATIC credentials, and CONFIG-only (incomplete) profiles
  • Default Profile Marker: ✓ shows which profile is set as default
  • Expiration Countdown: Real-time display of remaining session time
  • Automatic Session Loading: Auto-loads cached SSO sessions on startup
  • Profile Management: Create, rename, and delete AWS credential profiles
  • Console Access: One-key access to AWS Console with federated sign-in
  • Smart Cache: Disk cache with automatic invalidation when config files change

Setup:

  1. Launch TUI: awsom
  2. Select an SSO session and press Enter to login
  3. Follow the interactive prompts to configure your SSO (if not already configured)
  4. Authenticate in your browser and start managing your AWS sessions!

4. Browse EC2 Instances (Optional)

Press s to open the SSM Browser and view your EC2 instances:

  • See all instances across your accounts with real-time status
  • Filter and sort to find the right instance
  • Press Enter to connect via AWS Systems Manager
  • Copy SSM commands with y for use in scripts

Note: Requires AWS Session Manager Plugin to be installed for connecting to instances.

CLI Commands

📖 For complete command reference with session resolution logic and examples, see COMMANDS.md

Global Options

All commands support these global flags:

  • -v, --verbose: Enable debug logging to see detailed operation information
  • --start-url <URL>: SSO start URL (or set AWS_SSO_START_URL)
  • --region <REGION>: AWS region for SSO (or set AWS_SSO_REGION)
  • --headless: Force headless mode - shows URL in TUI instead of opening browser (auto-detected in SSH/Docker)

profile - Manage profiles and credentials

Profile commands allow you to list accounts, refresh credentials, execute commands, export credentials, and open the AWS Console.

profile list - List accounts and roles

awsom profile list [--format text|json]

profile start - Refresh credentials for existing profile

awsom profile start my-profile

Refreshes temporary credentials for an existing profile. Useful for keeping long-running sessions active.

profile exec - Execute command with credentials

awsom profile exec --role-name Developer --account-name Production -- aws s3 ls

Options:

  • --account-id <ID>: Account ID
  • --account-name <NAME>: Account name (alternative to account-id)
  • --role-name <ROLE>: Role name
  • Command follows --

profile export - Export credentials

# Export as environment variables
awsom profile export --role-name Developer --account-name Production
eval $(awsom profile export --role-name Developer --account-name Production)

# Or write to AWS credentials file
awsom profile export --role-name Developer --account-name Production --profile my-profile

Options:

  • --account-id <ID>: Account ID
  • --account-name <NAME>: Account name (alternative to account-id)
  • --role-name <ROLE>: Role name
  • --profile <NAME>: Write to ~/.aws/credentials as this profile

profile console - Open AWS Console in browser

# Using an existing profile
awsom profile console --profile staging

# Or specify account/role directly
awsom profile console --role-name Developer --account-name Production

Opens the AWS Console in your default browser using federated sign-in with temporary credentials.

Options:

  • --profile <NAME>: Use an existing SSO profile (reads account/role from config)
  • --account-id <ID>: Account ID
  • --account-name <NAME>: Account name (alternative to account-id)
  • --role-name <ROLE>: Role name (required unless --profile is used)
  • --region <REGION>: AWS region to open console in (defaults to profile default or SSO region)

session - Manage SSO sessions

Perfect for automation, CI/CD, and provisioning scripts!

The session subcommand provides complete CLI management of SSO sessions without requiring the TUI.

session add - Add a new SSO session

awsom session add \
  --name my-org-sso \
  --start-url https://my-org.awsapps.com/start \
  --region us-east-1

Creates a new SSO session configuration and saves it to ~/.aws/config. Great for:

  • Provisioning scripts: Automate setup for new team members
  • CI/CD pipelines: Configure AWS access in build environments
  • Infrastructure as Code: Manage SSO configuration declaratively

session list - List all SSO sessions

# Human-readable format
awsom session list

# JSON format for scripting
awsom session list --format json

Example output (text):

SSO Sessions (2):

  production-sso
    Start URL: https://prod.awsapps.com/start
    Region: us-east-1

  staging-sso
    Start URL: https://stage.awsapps.com/start
    Region: us-west-2

Example output (JSON):

[
  {
    "name": "production-sso",
    "start_url": "https://prod.awsapps.com/start",
    "region": "us-east-1",
    "registration_scopes": "sso:account:access"
  },
  {
    "name": "staging-sso",
    "start_url": "https://stage.awsapps.com/start",
    "region": "us-west-2",
    "registration_scopes": "sso:account:access"
  }
]

session delete - Delete an SSO session

# Interactive confirmation
awsom session delete my-org-sso

# Force deletion without confirmation (for scripts)
awsom session delete my-org-sso --force

Removes the session from ~/.aws/config. Use --force in automation scripts to skip the confirmation prompt.

session edit - Edit an existing SSO session

# Update start URL
awsom session edit my-org-sso \
  --start-url https://new-url.awsapps.com/start

# Update region
awsom session edit my-org-sso \
  --region us-west-2

# Update both
awsom session edit my-org-sso \
  --start-url https://new-url.awsapps.com/start \
  --region us-west-2

Updates an existing session configuration. You'll need to re-authenticate after changing the start URL.

session switch - Switch active session

awsom session switch my-org-sso

Selects which SSO session to use (placeholder for future multi-session support). For now, use the TUI to switch between sessions interactively.

Automation Example:

#!/bin/bash
# setup-aws-sso.sh - Provision AWS SSO for new environment

# Add SSO sessions for different environments
awsom session add \
  --name prod-sso \
  --start-url https://prod.awsapps.com/start \
  --region us-east-1

awsom session add \
  --name stage-sso \
  --start-url https://stage.awsapps.com/start \
  --region us-west-2

# List configured sessions
awsom session list --format json | jq '.[] | .name'

# Authenticate with production
awsom session login --start-url https://prod.awsapps.com/start --region us-east-1

# Export common profiles
awsom profile export --account-name Production --role-name Developer --profile prod-dev

completions - Generate shell completions

awsom completions <SHELL>

Generate shell completion scripts for bash, zsh, fish, powershell, or elvish. See Shell Completion section for installation instructions.

Configuration

awsom uses ~/.aws/config as the single source of truth for SSO configuration, following AWS CLI v2 conventions. No separate configuration file is needed!

Interactive Configuration

When you first run awsom and select a session to login (press Enter), if no SSO configuration exists, you'll be guided through an interactive 3-step wizard that will:

  1. Ask for your SSO Start URL (e.g., https://your-org.awsapps.com/start)
  2. Ask for your SSO Region (e.g., us-east-1)
  3. Ask for an optional Session Name (default: default-sso)

The configuration will be automatically saved to ~/.aws/config as a [sso-session] section.

Manual Configuration

You can also manually edit ~/.aws/config to add or update SSO sessions:

[sso-session my-sso]
sso_start_url = https://your-org.awsapps.com/start
sso_region = us-east-1
sso_registration_scopes = sso:account:access

Or use the AWS CLI to configure SSO:

aws configure sso-session

Environment Variables

You can override SSO configuration with environment variables:

  • AWS_SSO_START_URL: SSO start URL
  • AWS_SSO_REGION: SSO region
  • AWSOM_DEFAULT_REGION: Pre-fills default region in profile creation wizard (e.g., us-east-1)
  • AWSOM_DEFAULT_OUTPUT: Pre-fills default output format in profile creation wizard (e.g., json)

Configuration Priority

Settings are loaded in this order (later sources override earlier ones):

  1. ~/.aws/config [sso-session] sections
  2. Environment variables (AWS_SSO_START_URL, AWS_SSO_REGION)
  3. CLI flags (--start-url, --region)

Cache Locations

Compatible with AWS CLI v2:

  • SSO tokens: ~/.aws/sso/cache/
  • Role credentials: ~/.aws/cli/cache/

Project Structure

awsom/
├── src/
│   ├── auth/           # SSO OIDC authentication & token caching
│   ├── credentials/    # Credential fetching and caching
│   ├── aws_config.rs   # AWS credentials file management
│   ├── console/        # AWS Console federated sign-in
│   ├── session/        # Session management
│   ├── ssm/            # EC2 instance browsing via AWS Systems Manager
│   │   ├── client.rs   # SSM/EC2 SDK integration
│   │   └── mod.rs
│   ├── ui/             # TUI components (Ratatui)
│   │   ├── app.rs      # Main TUI application
│   │   └── symbols.rs  # Platform-agnostic symbol rendering
│   ├── cli/            # CLI commands
│   │   └── commands/   # Individual command implementations
│   ├── config/         # Configuration management
│   ├── expiry/         # Expiry tracking utilities
│   ├── cache.rs        # Disk-based profile cache
│   ├── models.rs       # Core data models
│   ├── error.rs        # Error types
│   └── main.rs         # Application entry point
├── Cargo.toml
├── CHANGELOG.md
└── README.md

Development Status

✅ Implemented & Tested

  • Project structure and dependencies
  • Error handling framework with proper AWS SDK error types
  • Core data models (SsoToken, RoleCredentials, AccountRole, etc.)
  • AWS SSO OIDC authentication (device flow) ✅ Working
  • Token caching (AWS CLI v2 compatible) ✅ Working
  • Credential fetching from AWS SSO ✅ Working
  • AWS credentials file management (read/write/delete) ✅ Working
  • CLI interface with clap
  • profile command for managing profiles and credentials ✅ Working
    • profile list - List accounts and roles
    • profile start - Refresh credentials for existing profile
    • profile exec - Execute commands with credentials
    • profile export - Export credentials
    • profile console - Open AWS Console in browser
  • session command for managing SSO sessions via CLI ✅ Working
    • session login for authentication
    • session logout for ending sessions
    • session status for session checking and automation
    • session add for creating sessions programmatically
    • session list with text/JSON output
    • session delete with force flag for automation
    • session edit for updating session configuration
    • session switch for multi-session support (WIP)
  • completions command for shell completion ✅ Working
  • Verbose/debug logging with --verbose flag ✅ Working
  • TUI interface with Ratatui ✅ Working
    • k9s-style keyboard navigation (j/k, arrows)
    • Account/role list display with status indicators
    • Visual indicators (🟢 active / 🔴 inactive)
    • Default profile marker (✓)
    • Real-time expiration countdown
    • Help screen
    • Status bar with token expiry
    • Profile creation and deletion (Enter key)
    • Profile renaming (e key for edit)
    • Set default profile (d key)
    • Open AWS Console in browser (c key)
    • Login/logout in TUI (Enter key on Sessions pane)
    • Auto-load cached SSO sessions on startup

📋 Planned

  • Background session refresh
  • Desktop notifications
  • Multiple SSO instance support
  • Profile favorites/bookmarks
  • Interactive config editor in TUI

Architecture

Authentication Flow

  1. Register Client: Register with AWS SSO-OIDC
  2. Device Authorization: Start device authorization flow
  3. User Authorization: User authorizes in browser
  4. Token Exchange: Poll for access token
  5. Token Caching: Cache token in ~/.aws/sso/cache/

Credential Flow

  1. List Accounts: Fetch available AWS accounts
  2. List Roles: Get roles for each account
  3. Get Credentials: Fetch temporary credentials for selected role
  4. Cache Credentials: Store in ~/.aws/cli/cache/

Auto-Refresh Mechanism

  • Monitors SSO tokens and role credentials for expiration
  • Automatically refreshes credentials before they expire (when < 3 hours remaining)
  • Detects external changes to credential files and updates UI in real-time
  • Background refresh runs every 60 seconds to maintain active sessions

Symbol Abstraction Layer

  • Platform-agnostic symbol rendering via src/ui/symbols.rs
  • Automatic fallback to ASCII symbols on incompatible terminals
  • Controlled via AWSOM_ASCII_SYMBOLS environment variable
  • Supports Unicode emojis (🟢, 🔴, ✓) and ASCII equivalents ([+], [-], [x])

SSM Integration

  • EC2 instance browsing and management through AWS Systems Manager
  • Real-time instance status tracking (online/offline)
  • Integrated tag viewing and filtering
  • Direct SSM session connection from TUI

Building

# Check for errors
cargo check

# Build debug version
cargo build

# Build release version
cargo build --release

# Run
cargo run -- session login --start-url https://your-org.awsapps.com/start --region us-east-1

Testing

cargo test

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Inspiration

This project was inspired by the Python aws-sso-util by Ben Kehoe. We built awsom from scratch in Rust to provide a fast, modern TUI experience for AWS SSO management.

License

Apache-2.0

Troubleshooting

Enable Verbose Logging

If you encounter any issues, run commands with the --verbose flag to see detailed debug information:

awsom --verbose session login
awsom -v profile list

This will show:

  • Client registration details
  • Device authorization flow
  • Token polling status
  • API error messages
  • Credential fetching progress

Common Issues

"No SSO session found"

  • Run awsom session login first to authenticate

"Token expired"

  • Your SSO token has expired. Run awsom session login --force to re-authenticate

"Service error"

  • Use --verbose to see the full error message
  • Check your internet connection
  • Verify your --start-url and --region are correct

Roadmap

Current Status: v0.15.0 - Symbol Compatibility & SSM Browser! 🎉

All core features are now implemented and working:

Implemented Features:

  • ✅ AWS SSO authentication with device flow
  • ✅ Full TUI interface with profile management
  • ✅ All CLI commands (session, profile, completions)
  • ✅ AWS credentials file integration
  • ✅ Console federated sign-in
  • ✅ Session status checking for automation (via session status)
  • ✅ Real-time expiration tracking
  • ✅ Profile management (create, rename, delete, set default)
  • ✅ Configuration file support
  • ✅ Static credentials support (non-SSO profiles)
  • ✅ Incomplete profile detection (config-only profiles)
  • ✅ Smart disk cache with automatic invalidation (v0.7.0)
  • ✅ Account caching and session filtering (v0.6.0)
  • ✅ Auto-refresh for external credential changes (v0.12.0)
  • ✅ Automatic credential renewal before expiration (v0.13.0)
  • ✅ SSM Browser for EC2 instance management (v0.14.0)
  • ✅ Platform-agnostic symbol rendering with ASCII fallback (v0.15.0)

Future Enhancements:

  • Desktop notifications for expiring sessions
  • Profile favorites/bookmarks
  • Session history and analytics
  • Multi-region SSM instance browsing
  • Enhanced filtering and search capabilities

About

k9s-like TUI for AWS SSO sessions

Resources

Readme

License

Apache-2.0 license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 25

Release v0.16.1 Latest
Dec 3, 2025
+ 24 releases

Packages

 
 
 

Contributors

Languages