Skip to content

sandeshgrangdan/ssm-tui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AWS Systems Manager - Parameter Store TUI Client

This project serves as a learning exercise in Rust, Tokio, Channels, and TUI (Terminal User Interface) programming. It is a DevOps tool used to manages existing Parameter Store with a Terminal User Interface (TUI), utilizing technologies such as Tokio, Ratatui and Vim.

Screenshot 2024-08-17 at 10 50 15 PM

Prerequisite

  1. Install and configure AWS CLI.
  2. Vim
  3. Make sure you have Rust and Cargo installed (Optional).

Note: This project is not suitable for production use. It's designed strictly for educational purposes.

Installation

From binaries (Linux, macOS, Windows)

Install prebuilt binaries via shell script (Linux, macOS)

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/sandeshgrangdan/ssm-tui/releases/download/v0.1.0/ssm-tui-installer.sh | sh

Install prebuilt binaries via powershell script (Windows)

powershell -c "irm https://github.com/sandeshgrangdan/ssm-tui/releases/download/v0.1.0/ssm-tui-installer.ps1 | iex"

Cargo

Use this option if your architecture is not supported by the pre-built binaries found on the releases page.

First, install Rust (using the recommended rustup installation method) and then

cargo install ssm-tui

This method will build the binary from source.

To update, run the same command again.

git clone git@github.com:sandeshgrangdan/ssm-tui.git
cargo build --release
cd target/release/
./ssm-tui

Usage

$ ssm-tui
$ ssm-tui -h
AWS Systems Manager - Parameter Store TUI Client

Usage: ssm-tui [OPTIONS]

Options:
  -p, --profile <PROFILE>  Name of your AWS profile [default: None]
  -r, --region <REGION>    AWS Region [default: None]
  -h, --help               Print help
  -V, --version            Print version

Setup Instructions (Development)

To get the project up and running, follow these steps:

  1. Clone the repository: git clone git@github.com:sandeshgrangdan/ssm-tui.git
  2. Start the tui: cargo run