bolt-tui

Bolt TUI ( bolt-tui)

A Terminal User Interface (TUI) for viewing and managing BoltDB files. Built with Go and the Bubbletea framework.

Features

• 🗂️ Interactive File Picker: Browse and select BoltDB files from your filesystem
• 📊 Database Browser: View all buckets and their key-value pairs
• ✏️ Edit Operations: Create, update, and delete buckets and keys
• ⌨️ Keyboard Navigation: Full keyboard support with intuitive shortcuts
• 🔍 Help System: Built-in help to guide you through available commands
• 📑 Tab Navigation: Organize your work with multiple tabs

Installation

Prerequisites

• Go 1.24.1 or higher

Build From Source

git clone https://github.com/lunargon/bolt-tui.git
cd bolt-tui
go build -o bolt-tui cli/main.go

Usage

Basic Usage

Run the application to open the file picker:

./bolt-tui

CLI Options

Open a specific BoltDB file directly:

./bolt-tui -f /path/to/your/database.db

Start file picker in a specific directory:

./bolt-tui -d /path/to/directory

Use current directory:

./bolt-tui -d .

Keyboard Shortcuts

General Navigation

Tab Management

Bucket Operations

Key-Value Operations

Project Structure

bolt-tui/
├── main.go              # Test entry point with file picker ( for testing)
├── cli/
│   └── main.go          # CLI entry point
├── src/
│   ├── app/             # TUI application logic
│   │   ├── model.go     # Main application model and UI
│   │   └── helper.go    # Helper functions
│   ├── bolt/            # BoltDB wrapper
│   │   └── bolt.go      # Database operations
│   └── cmd/             # CLI commands
│       └── main.go      # Cobra command definitions
├── seed/                # Database seeding utilities
│   └── seed.go
├── go.mod               # Go module definition
├── go.sum               # Go module checksums
└── README.md            # This file

Dependencies

• BoltDB - Embedded key/value database
• Bubbletea - TUI framework
• Bubbles - TUI components
• Lipgloss - Style definitions
• Cobra - CLI framework

Development

Building

Build the main CLI application:

go build -o bolt-tui cli/main.go

Running Tests

Seed .db file for testing:

go run seed/seed.go

Run the main CLI application:

go run cli/main.go

Or run the test entry point (for testing purposes):

go run main.go

Building for Different Platforms

# Linux
GOOS=linux GOARCH=amd64 go build -o bolt-tui-linux

# macOS
GOOS=darwin GOARCH=amd64 go build -o bolt-tui-macos

# Windows
GOOS=windows GOARCH=amd64 go build -o bolt-tui-windows.exe

Todo

• Refactor
• Update UI
• Add feature to jump tab with number
• Have switch to view byte value or string value

Example

Contributing

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

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Built with Charm TUI libraries
• Inspired by the need for a simple, interactive BoltDB browser
• Thanks to the Go community for excellent tooling and libraries