Spectacle 👓

An interactive TUI that powers your endeavour in ETCD

✨ Features

• 🚀 Fast and lightweight TUI built with Bubble Tea
• 🔍 Intuitive navigation and data exploration
• 💾 Secure connection management
• 🎨 Beautiful terminal interface styled with Lipgloss
• 🔐 Support for TLS and authentication
• 🌐 Works with single node and cluster setups
• ⚡ Real-time updates and monitoring
• 🔄 Session persistence

🚀 Installation

Using Go

go install github.com/MayukhSobo/Spectacle@latest

From Source

git clone https://github.com/MayukhSobo/Spectacle.git
cd Spectacle
make build

📖 Usage

Simply run:

spectacle

🎮 Navigation

• ↑ ↓ Arrow keys to navigate
• Enter to select/expand
• ESC to go back
• q to quit
• / to search
• More keybindings available in-app

🛠 Development

Prerequisites

• Go 1.21+
• Docker (for local development)
• Pre-commit hooks
• golangci-lint
• make

Project Structure

Spectacle/
├── cmd/          # CLI commands
├── internal/     # Internal packages
│   └── app/     # TUI components
│       ├── home/       # Home screen
│       ├── savedconns/ # Saved connections
│       └── common/     # Shared components
├── logger/       # Logging utilities
└── dev/         # Development utilities

Local Setup

1. Clone the repository

   git clone https://github.com/MayukhSobo/Spectacle.git
   cd Spectacle

2. Install dependencies

   go mod download

3. Install development tools

   make setup-dev

4. Start local ETCD

   docker-compose -f dev/docker-compose.yaml up -d

5. Run tests

   make test

Code Quality

• Pre-commit hooks ensure code quality
• golangci-lint for static code analysis
• Unit tests for core functionality
• Integration tests with ETCD

🤝 Contributing

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

📝 License

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

🙏 Acknowledgments

• Bubble Tea for the TUI framework
• Lip Gloss for terminal styling
• ETCD for the amazing distributed key-value store