CloudCtl

   ██████╗██╗      ██████╗ ██╗   ██╗██████╗  ██████╗████████╗██╗     
  ██╔════╝██║     ██╔═══██╗██║   ██║██╔══██╗██╔════╝╚══██╔══╝██║     
  ██║     ██║     ██║   ██║██║   ██║██║  ██║██║        ██║   ██║     
  ██║     ██║     ██║   ██║██║   ██║██║  ██║██║        ██║   ██║     
  ╚██████╗███████╗╚██████╔╝╚██████╔╝██████╔╝╚██████╗   ██║   ███████╗
   ╚═════╝╚══════╝ ╚═════╝  ╚═════╝ ╚═════╝  ╚═════╝   ╚═╝   ╚══════╝

A lightweight CLI tool for securely managing AWS AssumeRole sessions with MFA support and encrypted credential storage.

Features

🔐 Secure Credential Storage - Encrypt AWS credentials with AES-256-GCM
🎯 AssumeRole Support - Easily assume IAM roles with MFA
🎨 Enhanced Gradient CLI - Beautiful 24-bit color gradient UI
🤖 Auto-Refresh Daemon - Background service with self-forking & macOS LaunchAgent support
📂 Role Aliasing - Bulk import/export IAM roles via JSON
🌐 Console Access - Generate AWS console URLs instantly
🧩 Hybrid Login - Reuse existing sessions as source for role assumption
🏗️ Smart Sync - Export sessions to ~/.aws/credentials with session type tracking
Interactive TUI: Modern, interactive prompts sorted alphabetically (A-Z) for easy selection.
Touch ID Support: Securely store encryption keys in macOS Keychain for passwordless operation.
MFA Session Caching: Enter MFA once, assume unlimited roles for 12 hours.
🐚 Shell Integration - Display current session and remaining time in your shell prompt.
🔒 Masked MFA Input - Asterisk display (******) for MFA codes with backspace support.
🛡️ Session Persistence - Automatically tracks AWS Region to ensure correct API calls during refresh.

Installation

Prerequisites

Go 1.22 or higher
AWS CLI configured with at least one profile
Valid AWS credentials

Homebrew (macOS)

# Add the tap
brew tap chukul/homebrew-tap

# Install cloudctl
brew install cloudctl

Build from Source

# Clone the repository
git clone https://github.com/chukul/cloudctl.git
cd cloudctl

# Build the binary
go build

# (Optional) Move to PATH
sudo mv cloudctl /usr/local/bin/

Shell Integration (Recommended)

Set up shell integration for the best experience:

# Generate and add to your shell config
cloudctl init >> ~/.zshrc  # or ~/.bashrc for Bash

# Edit ~/.zshrc and set your encryption secret
export CLOUDCTL_SECRET="your-32-char-encryption-key"

# Reload your shell
source ~/.zshrc

After setup, you get:

ccs <profile> - Quick switch without eval
ccl - Alias for cloudctl login
ccst - Alias for cloudctl status
ccr - Alias for cloudctl refresh
ccc - Alias for cloudctl console
ccm - Alias for cloudctl mfa-login
Shell prompt showing current session and remaining time

Quick Start

1. MFA Session (Recommended for Multiple Roles)

If you need to assume multiple roles with MFA, get an MFA session first:

# Step 1: Get MFA session once (valid for 12 hours)
cloudctl mfa-login \
  --source default \
  --profile mfa-session \
  --mfa arn:aws:iam::123456789012:mfa/username
# Enter MFA code when prompted (displays as ******)

# Step 2: Use MFA session to assume multiple roles (no MFA needed!)
cloudctl login --source mfa-session --profile prod-admin --role arn:aws:iam::123456789012:role/AdminRole
cloudctl login --source mfa-session --profile dev-readonly --role arn:aws:iam::123456789012:role/ReadOnlyRole
cloudctl login --source mfa-session --profile staging --role arn:aws:iam::987654321098:role/StagingRole

2. Login and Assume Role

Assume an IAM role and store the credentials securely:

cloudctl login \
  --source <source-profile> \
  --profile <session-name> \
  --role <role-arn> \
  --secret "your-32-char-encryption-key" \
  --region ap-southeast-1

Example:

cloudctl login \
  --source default \
  --profile prod-admin \
  --role arn:aws:iam::123456789012:role/AdminRole \
  --secret "1234567890ABCDEF1234567890ABCDEF"

With MFA (single role):

cloudctl login \
  --source default \
  --profile prod-admin \
  --role arn:aws:iam::123456789012:role/AdminRole \
  --mfa arn:aws:iam::123456789012:mfa/username \
  --secret "1234567890ABCDEF1234567890ABCDEF"

With auto-open console:

cloudctl login \
  --source mfa-session \
  --profile uat_ca \
  --role arn:aws:iam::814348778342:role/CIMBTH_CloudAdministrator \
  --open

3. View Stored Sessions

List all stored sessions with their status:

cloudctl status --secret "1234567890ABCDEF1234567890ABCDEF"

Output:

Active Sessions
────────────────────────────────────────────────────────────────────────────────
🟢 prod-admin ← current      AdminRole (123456789012)           45m remaining
   Expires: 2025-11-20 10:30:00

🔒 mfa-session               MFA Session                        11h45m remaining
   Expires: 2025-11-20 22:30:00

Expiring Soon
────────────────────────────────────────────────────────────────────────────────
🟡 staging                   DevOpsRole (987654321098)          12m remaining
   Expires: 2025-11-20 09:42:00

Status Icons:

🟢 Green (ACTIVE) - Session has more than 15 minutes remaining
🟡 Yellow (EXPIRING) - Session expires in 15 minutes or less
🔴 Red (EXPIRED) - Session has expired
🔒 Lock (MFA SESSION) - MFA session token

4. Quick Switch Between Profiles

Fast profile switching with one command:

# Set your secret once
export CLOUDCTL_SECRET="1234567890ABCDEF1234567890ABCDEF"

# Switch to any profile instantly
eval $(cloudctl switch prod-admin)
eval $(cloudctl switch dev-readonly)

# Or use the shell function (if init is configured)
ccs prod-admin

# Verify
aws sts get-caller-identity

Important: Unset AWS_PROFILE if it's already set in your environment:

unset AWS_PROFILE
eval $(cloudctl switch prod-admin)

5. Smart Refresh & Restore

Keep your sessions alive or restore expired ones using stored metadata. cloudctl will automatically decide between a silent refresh or an interactive MFA-based restore.

# Smart refresh interactively (Sorted A-Z)
cloudctl refresh

# Refresh specific profile
cloudctl refresh prod-admin

# Force interactive re-login even if still active
cloudctl refresh prod-admin --force

# Silent refresh for all active sessions (Used by Daemon)
cloudctl refresh --all

6. Auto-Refresh Daemon (macOS Plugin)

Keep your sessions alive automatically. The daemon tracks the Region of each session to perform silent refreshes.

# 1. Setup automatic startup (macOS only)
cloudctl daemon setup
launchctl load ~/Library/LaunchAgents/com.chukul.cloudctl.plist

# 2. Start (Runs in background automatically via self-forking)
cloudctl daemon start

# 3. View status and logs
cloudctl daemon status
cloudctl daemon logs

# 4. Stop
cloudctl daemon stop

# 5. Run in foreground (for debugging)
cloudctl daemon start --foreground

7. Refresh Sessions

See Smart Refresh & Restore for detailed usage.

7. Logout

Remove stored credentials:

# Remove specific profile
cloudctl logout --profile prod-admin

# Remove all profiles
cloudctl logout --all

🔐 Touch ID & Security (macOS)

On macOS, cloudctl can store your encryption key securely in the System Keychain. This allows you to use cloudctl without manually setting the CLOUDCTL_SECRET environment variable.

Run cloudctl login (or any command) without a secret.
Follow the prompt to generate and store a secure key.
Future commands will use Touch ID / User Password to unlock the key automatically.

🛡️ Backup & Restore

Since your credentials are encrypted, you must backup your key!

# Reveal your key (requires Touch ID)
cloudctl secret show

# Save the output to your password manager

To restore on a new machine (or if you reinstall OS):

# Import your backed-up key into Keychain
cloudctl secret import <your-key>

🎭 IAM Role Management

Save frequently used IAM Roles with friendly aliases.

# Add a role alias
cloudctl role add prod-admin arn:aws:iam::123456789012:role/ProductionAdmin

# List saved roles
cloudctl role list

# Export roles to JSON
cloudctl role export all-roles.json

# Import roles from JSON (Bulk onboarding)
cloudctl role import all-roles.json

# Use alias in login
cloudctl login --source default --profile prod --role prod-admin

📱 MFA Device Management

Save your MFA devices with friendly names to avoid typing ARNs.

# Add a device alias
cloudctl mfa add iphone arn:aws:iam::123456789012:mfa/my-user

# List saved devices
cloudctl mfa list

# Use alias in login
cloudctl mfa-login --mfa iphone

7. Credential Sync

Export your active cloudctl sessions to ~/.aws/credentials. The command identifies whether a session is a Role or MFA session in the comments.

# Interactive sync with session type labeling (MFA or Role)
cloudctl sync

# Sync all active sessions without prompt
cloudctl sync --all

# Sync specific profile
cloudctl sync --profile prod-admin

Note: cloudctl automatically detects your secret from macOS Keychain or environment variables. No --secret flag needed if setup.

Commands Reference

`mfa-login`

Get MFA session token to use for multiple role assumptions.

Flags:

--source - Source AWS CLI profile for base credentials (required)
--profile - Name to store the MFA session as (required)
--mfa - MFA device ARN (required)
--secret - Encryption key for credential storage (or set CLOUDCTL_SECRET env var)
--duration - Session duration in seconds (default: 43200 = 12 hours, max: 129600 = 36 hours)

Usage:

# Get MFA session (valid for 12 hours)
cloudctl mfa-login --source default --profile mfa-session --mfa arn:aws:iam::123:mfa/user

# Use MFA session to assume roles without re-entering MFA
cloudctl login --source mfa-session --profile role1 --role arn:aws:iam::123:role/Role1
cloudctl login --source mfa-session --profile role2 --role arn:aws:iam::456:role/Role2

`login`

Assume an AWS role and store credentials locally.

Flags:

--source - Source AWS CLI profile or cloudctl session for base credentials (required)
--profile - Name to store the new session as (required)
--role - Target IAM role ARN to assume (required)
--mfa - MFA device ARN (optional)
--secret - Encryption key for credential storage (or set CLOUDCTL_SECRET env var)
--region - AWS region (default: ap-southeast-1)
--open - Automatically open AWS Console after successful login
--duration - Session duration in seconds (default: 3600 = 1 hr, max: 43200 = 12 hrs)

Usage:

# Basic login
cloudctl login --source default --profile prod --role arn:aws:iam::123:role/Admin

# With MFA
cloudctl login --source default --profile prod --role arn:aws:iam::123:role/Admin --mfa arn:aws:iam::123:mfa/user

# With auto-open console
cloudctl login --source mfa-session --profile prod --role arn:aws:iam::123:role/Admin --open

`status`

Show all stored AWS sessions with enhanced visual display.

Features:

Status icons: 🟢 Active | 🟡 Expiring | 🔴 Expired | 🔒 MFA Session
Grouped by status (Active → Expiring → Expired)
Account ID and role name extraction for cleaner display
Current session highlighting (← current)
Helpful onboarding message when no sessions exist

Flags:

--secret - Encryption key to decrypt credentials (or set CLOUDCTL_SECRET env var)

Usage:

cloudctl status
# or
ccst  # if shell integration is configured

Example Output:

Active Sessions
────────────────────────────────────────────────────────────────────────────────
🟢 prod-admin ← current      AdminRole (123456789012)           45m remaining
   Expires: 2025-11-20 10:30:00

🔒 mfa-session               MFA Session                        11h45m remaining
   Expires: 2025-11-20 22:30:00

Expiring Soon
────────────────────────────────────────────────────────────────────────────────
🟡 staging                   DevOpsRole (987654321098)          12m remaining
   Expires: 2025-11-20 09:42:00

`switch`

Quick switch to a profile and export credentials. Only active (non-expired) sessions are shown in the interactive list.

Usage:

# Interactive selection (Sorted A-Z, filtering out expired ones)
eval $(cloudctl switch)

# Specific profile
eval $(cloudctl switch prod-admin)

`console`

Generate AWS Console sign-in URL from stored session.

Usage:

# Interactive mode (select from active profiles)
cloudctl console --open

# Specific profile
cloudctl console --profile prod-admin --open

Note: MFA sessions cannot be used for console access. Use an assumed role profile instead.

`refresh`

Smart refresh or restore AWS sessions. It re-uses stored metadata (Source, Role, MFA, Region) to renew credentials.

Logic:

Active Session: Attempts silent refresh without prompt.
Expired/MFA Session: Prompts for MFA token and performs a full re-login.

Flags:

--all - Refresh all active sessions silently (skips expired/interactive ones).
--profile - Specific profile to refresh.
--force (-f) - Force interactive re-login even if session is still active.
--secret - Encryption key for decryption.

Usage:

# Interactive smart selection
cloudctl refresh

# Specific profile
cloudctl refresh prod-admin

# Silent refresh all (best for automation)
cloudctl refresh --all

`init`

Generate shell integration code for easy setup.

Usage:

# Add to your shell config
cloudctl init >> ~/.zshrc

# Or view the output
cloudctl init

What it provides:

ccs <profile> - Quick switch function without eval
ccl - Alias for cloudctl login
ccst - Alias for cloudctl status
ccr - Alias for cloudctl refresh
ccc - Alias for cloudctl console
ccm - Alias for cloudctl mfa-login
Shell prompt integration showing current session
CLOUDCTL_SECRET environment variable setup

`prompt`

Display current session info for shell prompt integration.

Subcommands:

cloudctl prompt - Display formatted prompt string (e.g., ☁️ prod-admin (45m))
cloudctl prompt info - Display detailed session info in JSON format
cloudctl prompt setup - Show shell integration setup instructions

Flags:

--secret - Encryption key to decrypt credentials (or set CLOUDCTL_SECRET env var)

Usage:

# In your shell prompt (PS1 or PROMPT)
$(cloudctl prompt)

# Get detailed info
cloudctl prompt info

`logout`

Remove stored credentials.

Flags:

--profile - Profile to remove
--all - Remove all profiles

Usage:

# Remove specific profile
cloudctl logout --profile prod-admin

# Remove all profiles
cloudctl logout --all

Configuration

Encryption Key

CloudCtl uses AES-256-GCM encryption for storing credentials. Your encryption key should be:

Exactly 32 characters long
Kept secure and not shared
The same key must be used for storing and retrieving credentials

Example key generation:

# Generate a random 32-character key
openssl rand -hex 16

Set as environment variable:

export CLOUDCTL_SECRET="1234567890ABCDEF1234567890ABCDEF"

Storage Location

Credentials are stored in:

~/.cloudctl/credentials.json  # Encrypted credentials
~/.cloudctl/sessions/         # Session files

These files contain encrypted credentials and should be kept secure.

Security Best Practices

Use Strong Encryption Keys - Generate random 32-character keys
Don't Commit Secrets - Never commit your encryption key or credentials
Rotate Sessions - Regularly refresh your assumed role sessions
Use MFA - Enable MFA for sensitive role assumptions
Limit Session Duration - Use appropriate session durations (default: 1 hour for roles, 12 hours for MFA)
Secure Storage - Ensure ~/.cloudctl/ directory has proper permissions (0700)

Troubleshooting

CloudCtl provides helpful error messages with troubleshooting tips. Here are common scenarios:

"The config profile (X) could not be found"

This error occurs when AWS_PROFILE is set in your environment. Unset it:

unset AWS_PROFILE
eval $(cloudctl switch prod-admin)

"Failed to load source profile"

CloudCtl will automatically list available AWS profiles and cloudctl sessions:

❌ Profile 'default' not found

💡 Available AWS profiles:
   • prod
   • dev
   • staging

💡 To create a new profile:
   aws configure --profile default

"Invalid secret key"

The encryption key used for decryption doesn't match the one used for encryption. Ensure you're using the same 32-character key.

"Failed to assume role"

CloudCtl provides detailed troubleshooting:

❌ Failed to assume role: AccessDenied

💡 Common issues:
   • Check the role ARN is correct
   • Verify the role's trust policy allows your source identity
   • Ensure your source credentials have sts:AssumeRole permission
   • Check if the role requires MFA (use --mfa flag)

MFA Code Not Working

CloudCtl shows helpful tips:

❌ MFA authentication failed

💡 Common issues:
   • Check your MFA code is current (not expired)
   • Verify MFA device ARN is correct
   • Ensure device time is synchronized
   • MFA ARN format: arn:aws:iam::<account-id>:mfa/<username>

Console URL Not Opening

Check that you're using an assumed role profile (not an MFA session)
Verify the session hasn't expired
Ensure your browser is set as the default application for URLs

No Sessions Found

When running cloudctl status with no sessions, you'll see:

📭 No stored sessions found.

💡 Get started:
   cloudctl mfa-login --source <profile> --profile mfa-session --mfa <mfa-arn>
   cloudctl login --source <profile> --profile <name> --role <role-arn>

Development

Project Structure

cloudctl/
├── cmd/              # Command implementations
│   ├── console.go    # Console sign-in command
│   ├── daemon.go     # Auto-refresh daemon
│   ├── init.go       # Shell integration command
│   ├── login.go      # Login/assume role command
│   ├── logout.go     # Logout command
│   ├── mfa.go        # MFA device alias management
│   ├── mfa-login.go  # MFA session command
│   ├── prompt.go     # Shell prompt command
│   ├── refresh.go    # Smart refresh/restore command
│   ├── role.go       # Role alias management
│   ├── root.go       # Root command and CLI setup
│   ├── status.go     # Status command
│   ├── switch.go     # Quick switch command
│   ├── sync.go       # Credentials file sync
│   └── utils.go      # Shared utilities (MFA input)
├── internal/         # Internal packages
│   ├── aws.go        # AWS SDK helpers
│   ├── crypto.go     # Encryption/decryption logic
│   ├── keychain_darwin.go # macOS Keychain integration
│   ├── keychain_stub.go   # Stub for non-macOS platforms
│   ├── os_utils.go   # OS-specific utilities
│   ├── session.go    # Session types and handling
│   ├── storage.go    # Credential storage logic
│   ├── types.go      # Shared type definitions
│   └── ui/           # Interactive UI components
├── go.mod
├── go.sum
├── main.go
└── README.md

Building

# Build for current platform
go build

# Build for specific platform
GOOS=linux GOARCH=amd64 go build -o cloudctl-linux
GOOS=darwin GOARCH=arm64 go build -o cloudctl-macos
GOOS=windows GOARCH=amd64 go build -o cloudctl.exe

Testing

# Run tests
go test ./...

# Run with coverage
go test -cover ./...

Contributing

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

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

License

This project is open source and available under the MIT License.

Author

Chuchai Kultanahiran
Email: pong2day@gmail.com

Acknowledgments

Inspired by Leapp
Built with Cobra CLI framework
Uses AWS SDK for Go v2

Support

For issues, questions, or contributions, please visit:

GitHub Issues: https://github.com/chukul/cloudctl/issues
GitHub Repository: https://github.com/chukul/cloudctl

Name		Name	Last commit message	Last commit date
Latest commit History 46 Commits
.github/workflows		.github/workflows
.kiro/steering		.kiro/steering
cmd		cmd
internal		internal
scripts		scripts
.gitignore		.gitignore
.goreleaser.yaml		.goreleaser.yaml
IMPROVEMENTS.md		IMPROVEMENTS.md
README.md		README.md
VERSION_CHECK.md		VERSION_CHECK.md
go.mod		go.mod
go.sum		go.sum
main.go		main.go

chukul/cloudctl

Folders and files

Latest commit

History

Repository files navigation

CloudCtl

Features

Installation

Prerequisites

Homebrew (macOS)

Build from Source

Shell Integration (Recommended)

Quick Start

1. MFA Session (Recommended for Multiple Roles)

2. Login and Assume Role

3. View Stored Sessions

4. Quick Switch Between Profiles

5. Smart Refresh & Restore

6. Auto-Refresh Daemon (macOS Plugin)

7. Refresh Sessions

7. Logout

🔐 Touch ID & Security (macOS)

🛡️ Backup & Restore

🎭 IAM Role Management

📱 MFA Device Management

7. Credential Sync

Commands Reference

mfa-login

login

status

switch

console

refresh

init

prompt

logout

Configuration

Encryption Key

Storage Location

Security Best Practices

Troubleshooting

"The config profile (X) could not be found"

"Failed to load source profile"

"Invalid secret key"

"Failed to assume role"

MFA Code Not Working

Console URL Not Opening

No Sessions Found

Development

Project Structure

Building

Testing

Contributing

License

Author

Acknowledgments

Support

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Releases 3

Packages 0

Languages

`mfa-login`

`login`

`status`

`switch`

`console`

`refresh`

`init`

`prompt`

`logout`

Packages