GoTUI - Terminal UI for Go Development

⚠️ Experimental Work - Not Recommended for Use

This library is experimental work and is not recommended for production use. It is not in active development and may contain bugs, incomplete features, or breaking changes. Use at your own risk.

A modern terminal user interface for Go development that provides an integrated development environment in your terminal. Run tests, benchmarks, formatting, linting, and building with live output and intuitive navigation.

• Real-time Testing: Live go test -json output with hierarchical test tree view
• Performance Analysis: Sortable benchmark results with performance comparisons
• Code Formatting: Interactive gofmt diff preview with selective application
• Static Analysis: go vet and staticcheck integration with file navigation
• Build Monitoring: Live compilation output with error grouping

• Tabbed Interface: Clean tabbed navigation between different development tasks
• Keyboard-Driven: Full keyboard navigation with mnemonic shortcuts
• Editor Integration: Seamless integration with your preferred editor ($EDITOR)
• Live Updates: Real-time command output with ANSI color support
• Responsive Design: Adapts to terminal size changes

• Hot Reloading: Development mode with automatic rebuilds
• Comprehensive Testing: 90%+ test coverage with integration tests
• Structured Logging: Configurable logging with development/production modes
• Error Handling: Robust error handling with detailed context
• Clean Architecture: Modular design following Go best practices

# Clone the repository
git clone https://github.com/damirmukimov/gotui.git
cd gotui

# Build and install
make install

# Prerequisites: Go 1.25+
go version

# Clone and build
git clone https://github.com/damirmukimov/gotui.git
cd gotui
go build -o goutui ./cmd/goutui

# Optional: Install globally
sudo mv goutui /usr/local/bin/

# Install development dependencies
make setup-dev

# Run in development mode with hot reloading
make dev

# Or run tests continuously
make test

# Run in current Go project directory
goutui

# Run with debug logging
GOTUI_DEBUG=1 goutui

# Run with custom editor
EDITOR=code goutui

• Tab / Shift+Tab - Switch between tabs
• t / b / f / v / c - Jump to Tests/Benchmarks/Format/Vet/Build tabs
• q / Ctrl+C - Quit application
• r - Refresh current tab
• Esc - Return to tab bar from content

• ↑ / ↓ / j / k - Navigate lists
• Enter - Open selected item in editor
• Space - Expand/collapse tree items
• PgUp / PgDown - Page through content

• Command: go test -json ./...
• Features: Hierarchical test tree, pass/fail indicators, file navigation
• Navigation: Expand/collapse test suites, jump to failing tests

• Command: go test -bench=. ./...
• Features: Sortable performance table, historical comparisons
• Navigation: Sort by time, memory, or allocations

• Command: gofmt -d .
• Features: Diff preview, selective formatting, editor integration
• Actions: Apply formatting to individual files or all files

• Command: go vet ./... + staticcheck
• Features: Issue categorization, file and line navigation
• Integration: Direct jump to problematic code

• Command: go build ./...
• Features: Real-time compilation, error grouping
• Navigation: Jump to compilation errors

gotui/
├── cmd/goutui/           # Application entry point
├── internal/
│   ├── editor/           # Editor integration utilities
│   ├── errors/           # Error handling and types
│   ├── logger/           # Structured logging system
│   ├── runner/           # Command execution engine
│   ├── style/            # UI theming and styling
│   └── tui/
│       ├── components/   # Reusable UI components
│       ├── tabs/         # Tab implementations
│       └── model.go      # Main application model
├── .air.toml             # Hot reload configuration
├── .golangci.yml         # Linting configuration
└── Makefile              # Build and development tasks

• Bubble Tea Framework: Modern TUI framework with event-driven architecture
• Structured Logging: slog-based logging with configurable output formats
• Error Handling: Comprehensive error types with context preservation
• Command Runner: Async command execution with output streaming
• Component Architecture: Modular UI components with clean interfaces

# Enable debug logging and additional output
export GOTUI_DEBUG=1

# Set preferred editor (defaults to $EDITOR or $VISUAL)
export EDITOR=code
export VISUAL=nvim

# Enable development mode logging
export DEBUG=1

The .air.toml file configures hot reloading for development:

[build]
cmd = "go build -o ./tmp/goutui ./cmd/goutui"
bin = "./tmp/goutui"

[screen]
clear_on_rebuild = true

# Run all tests
make test

# Run tests with coverage
make test-cover

# Run tests in verbose mode
make test-verbose

# Run tests with race detection
make test-race

Current coverage by package:

• internal/logger: 100%
• internal/errors: 86.4%
• internal/editor: 58.2%

We welcome contributions! Please see our Contributing Guide for details.

# Fork and clone
git clone https://github.com/your-username/gotui.git
cd gotui

# Set up development environment
make setup-dev

# Run tests and linting
make ci

# Start development with hot reload
make dev

1. Setup: make setup-dev
2. Develop: make dev (with hot reloading)
3. Test: make test (continuous testing)
4. Lint: make lint (code quality)
5. Build: make build (production build)

• Contributing Guide
• Development Roadmap
• API Documentation (coming soon)

See ROADMAP.md for upcoming features and development priorities.

• Core TUI architecture with Bubble Tea
• All major tabs (Tests, Benchmarks, Format, Vet, Build)
• Editor integration and file navigation
• Comprehensive error handling and logging
• Development tooling and hot reloading

• Configuration file support
• Theme customization
• Coverage integration
• Git integration
• Plugin system

MIT License - see LICENSE for details.

Built with ❤️ using:

• Bubble Tea - The elegant TUI framework
• Bubbles - UI components
• Lip Gloss - Style definitions
• Air - Hot reloading for development

Happy Go Development! 🎉