dynamite

README

🧨🧨🧨

Amazon Dynamo-DB Query Engine for the Terminal.
A fast 2-pane TUI full of QOL features.

dynamite.webm

🚧 WORK IN PROGRESS 🚧

[!Warning] This is a work in progress!

Breaking changes may occur!

🤖 AI NOTICE 🤖

[!NOTE] At least up until the first release,

this project will be exclusively hand-crafted.

❔ Why

I wanted a TUI for quickly finding and browsing Amazon Dynamo-DB items. It needed quality of life features such as the ability to toggle columns on or off, easily copying items or fields, and sorting by a given field.

I couldn't find one that felt exactly right to me, so I decided to build one myself.

📦 Installation

Install the package using go:

# install
go install github.com/wolfwfr/dynamite/cmd/dynamite@latest

# execute
dynamite

Or build it from source:

# obtain
git clone git@github.com/wolfwfr/dynamite.git
cd dynamite

# build
go build -o dynamite ./cmd/dynamite/

# execute
./dynamite

🔨 Getting Started

Help

For help, simply run:

dynamite --help

Execute

Install Dynamite. Then execute with the valid AWS credentials:

[!NOTE]

Dynamite can only perform read-operations.

With AWS Credentials in Environment

# AWS_SESSION_TOKEN=*******
# AWS_PROFILE=******
dynamite

With an AWS Profile Flag

dynamite --aws_profile="my-profile"

TUI

• Navigate with arrow-keys or vim-bindings
• Quit with ctrl+c at any point
• Get Help with ?
• Tab between panes to shift focus for navigation or scrolling
• Select a table with Enter
• Search with /
• Escape search, dialogs, or the item-view with Esc
• Much more: see the help menu (with ?)

✨ Features

Among others, Dynamite offers:

• Easy Authentication: AWS authentication through environment or profile
• Region Selection: select and switch AWS region within the TUI
• Fuzzy Finding: quicly search and find what you need
• Syntax Highlighting: JSON/YAML views of your items with highlighting
• Visibility Toggle: only display the columns you're interested in
• Easy Sorting: quickly sort your results by any field (S, B, N)
• Flexible Formatting: Display your items as JSON or YAML
• Quick Copy: Copy table name, item field or the item JSON/YAML immediately
• Scan/Query: Scan and Query your table, select index, order, and set keys
• Open in Browser: Swiftly open the table or item in your browser and edit
• ZOOM: Don't need the second pane? Zoom in and only display what you need

🛣 Roadmap

☝️ This is a work in progress and the following is required for a first release:

• Code Polish: the code and its style require some polishing
• Testing: Improve and extend unit testing
• Compatibility: Test in different terminals & at different resolution scales
• Theme Configuration: use the config file to configure the colours to your liking
• README Polish: expand the README with images and video among others

✌️ Other features I have in mind are:

• DynamoDB Filter: implement integration with scan/query filter options
• CLI Extension: use CLI flags to hop straight into a table of choice or launch a query.
• Pane Configurability: configure width distribution of the 2 panes
• Transforms: transform column values, e.g. unix timestamps to human readable

✋ Non Goals

• ADMIN Mode: Although I'm considering it, I'm currently flagging write operations as a non-goal
• Full API Compatibility: Full integration with all of the aws-sdk-go-v2 dynamo-db related functions

🫴 Alternatives

• Sacha another 2-pane TUI that also integrates with S3, EC2, Lambda, and more!
• ddv a blazing fast dynamo-DB viewer for the terminal, written in Rust