⎈ devdash

A K9s-inspired terminal dashboard for Go developers

Run tests, check coverage, lint, benchmark, inspect dependencies, and monitor git status — all from one beautiful TUI.

Features • Quick Start • Shortcuts • Architecture • Contributing • License

---

✨ Features

Feature	Key	Description
🧪 Test Runner	t	Run go test ./... with pass/fail, package count & duration
📊 Coverage	c	Run go test -cover with color-coded percentage (🟢 ≥80% 🟡 ≥60% 🔴 <60%)
🔍 Linter	l	Run golangci-lint and display issue count with inline preview
⚡ Benchmarks	b	Run go test -bench with table of iterations & ns/op
📦 Binary Size	s	Build and measure compiled binary size
🌿 Git Status	g	Show modified/added/deleted/untracked files with colored indicators
📚 Dependencies	d	List all module dependencies via go list -m all
🔥 CPU Profile Flamegraph	p	Run go test -cpuprofile and render an inline Unicode flamegraph
📝 Markdown Report	m	Generate a complete dashboard report in elegant Markdown with emojis
🔎 Detail Views	Shift+Key	Full-screen output for tests, lint, benchmarks, git, deps & flamegraph

🎨 Design Philosophy

Inspired by K9s — the legendary Kubernetes TUI — devdash brings the same sleek, dark-themed, keyboard-driven experience to your Go development workflow:

• 🖤 Dark theme with cyan/teal accents
• 📍 Breadcrumb navigation between views
• 📊 Stat tiles with colored status dots (●/◍/○)
• 📋 Table layouts with alternating row highlights
• ⌨️ Command bar with discoverable key hints
• ⚡ Async execution — UI never blocks while commands run

---

🚀 Quick Start

Prerequisites

• Go 1.21 or later
• golangci-lint (optional, for lint panel) — install guide
• Git (for git status panel)

Install from source

go install github.com/chmenegatti/devdash/cmd/dashboard@latest

Post-install (PATH setup)

If dashboard is not found after installation, add your Go bin directory to PATH.

# Quick check
command -v dashboard

# Show install dirs
go env GOBIN GOPATH

Option A — asdf Go (recommended when using asdf):

echo 'export PATH="$(go env GOBIN):$PATH"' >> ~/.zshrc
source ~/.zshrc
asdf reshim golang

Option B — custom GOBIN:

echo 'export PATH="$(go env GOBIN):$PATH"' >> ~/.zshrc
source ~/.zshrc

Option C — default Go ($GOPATH/bin):

echo 'export PATH="$(go env GOPATH)/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

Temporary (current shell only):

export PATH="$(go env GOBIN):$PATH"

Or clone and build

git clone https://github.com/chmenegatti/devdash.git
cd devdash
go build -o devdash ./cmd/dashboard
./devdash

Run directly

# Navigate to any Go project, then:
devdash

💡 Tip: devdash auto-detects the project from your current working directory.

---

⌨️ Keyboard Shortcuts

Dashboard View

Key	Action
t	Run tests
c	Run coverage
l	Run linter
b	Run benchmarks
s	Measure binary size
g	Check git status
d	List dependencies
p	Run CPU profiling + inline flamegraph
m	Generate Markdown report
r	Reset all panels
q	Quit

Detail Views

Key	Action
T	Full test output
L	Full lint output
B	Full benchmark table
G	Full git status
D	Full dependency list
P	Full CPU flamegraph
Backspace	Back to dashboard

---

🏗 Architecture

devdash/
├── .github/
│   └── workflows/
│       ├── ci.yml          # ✅ Build/test/lint checks
│       └── release.yml     # 🚀 Tagged release artifacts
├── cmd/
│   └── dashboard/          # 🚀 Application entrypoint
│       └── main.go
├── internal/
│   ├── app/                # 🎮 Bubble Tea model (Update/View/Cmd)
│   │   ├── app.go          #     Central model, key dispatch, async wiring
│   │   └── layout.go       #     Layout helpers
│   ├── models/             # 📁 Project detection
│   │   └── project.go
│   ├── modules/            # ⚙️  Feature modules (one per panel)
│   │   ├── tests.go        #     go test runner & parser
│   │   ├── coverage.go     #     go test -cover parser
│   │   ├── lint.go         #     golangci-lint runner & parser
│   │   ├── benchmarks.go   #     go test -bench parser
│   │   ├── binary.go       #     Binary size measurement
│   │   ├── deps.go         #     go list -m all parser
│   │   ├── profile.go      #     CPU profiling + inline flamegraph builder
│   │   ├── report.go       #     Markdown report generation
│   │   └── gitstatus.go    #     git status --short parser
│   ├── services/           # 🔧 Shell command abstraction
│   │   ├── exec.go         #     RunCommand wrapper
│   │   └── parser.go       #     Line parsing utilities
│   ├── logs/               # 🪵 Structured file logging
│   │   └── logs.go         #     Logger and file configuration
│   ├── state/              # 💾 Centralized state management
│   │   └── state.go        #     Dashboard struct + result types
│   └── ui/                 # 🎨 K9s-inspired rendering
│       ├── styles.go       #     Color palette & Lipgloss styles
│       ├── components.go   #     Logo, crumbs, tables, command bar
│       ├── dashboard.go    #     Main dashboard composition
│       └── detail_views.go #     Full-screen detail renderers (+ scrollable output)
├── go.mod
├── go.sum
├── LICENSE
├── README.md
├── CONTRIBUTING.md
├── CHANGELOG.md
└── CODE_OF_CONDUCT.md

Design Patterns

• Bubble Tea (Elm Architecture) — Model → Update → View with pure rendering
• Async Commands — All shell operations run via tea.Cmd goroutines, never blocking the UI
• Layered Design — app → ui → modules → services → state
• Pure Parsers — Each module's parser takes a CommandResult and returns typed state — easy to unit test

Tech Stack

Library	Purpose
Bubble Tea	Terminal UI framework (Elm-style)
Lip Gloss	Styling, layout & colors
Bubbles	Viewport for scrollable detail outputs
Google pprof	CPU profile parsing for inline flamegraph rendering

---

🧪 Testing

# Run all tests
go test ./... -v

# Run with coverage
go test ./... -cover

# Run specific module tests
go test ./internal/modules/ -v -run TestParse

# Short mode (skip integration tests)
go test ./... -short

Currently 23 unit tests covering all module parsers plus integration tests for binary size measurement.

---

🪵 Logs & Troubleshooting

When command/module errors happen, devdash writes diagnostic entries to a local file named .devdash.log in the analyzed project directory.

# Follow logs in real time
tail -f .devdash.log

# View latest entries
tail -n 100 .devdash.log

Log entries include timestamp, level, failed command, execution duration, and truncated stdout/stderr snippets to speed up debugging.

---

🗺️ Roadmap

We welcome contributions for any of these planned features! See CONTRIBUTING.md.

• 🔄 Auto-refresh — Periodic re-run with configurable interval
• 📝 Markdown report export — Generate a complete dashboard report via keyboard shortcut
• 📜 Scrollable panels — Scroll through long outputs in detail views
• 🎛️ Config file — .devdash.yaml for custom panel layout, colors, and shortcuts
• 📈 Flame graphs — pprof integration with inline Unicode visualization
• 🐳 Docker support — Build & run inside containers
• 🔌 Plugin system — Custom panels via Go plugins or external scripts
• 🌐 Remote mode — Monitor CI/CD pipelines via SSH or API
• 📋 Clipboard — Copy panel output to clipboard
• 🎯 Focused test run — Run a single test function by name
• 📊 History — Track test/coverage trends over time
• 🔔 Notifications — Desktop alerts on test failure
• 🖥️ Resizable panes — Drag-to-resize panel layout

---

🤝 Contributing

We love contributions! Whether it's a bug fix, new feature, documentation improvement, or just a typo — every PR matters.

Please read our Contributing Guide and Code of Conduct before getting started.

# Fork & clone
git clone https://github.com/<your-user>/devdash.git
cd devdash

# Create a branch
git checkout -b feature/amazing-feature

# Make changes, then test
go test ./... -v
go vet ./...

# Commit & push
git add -A
git commit -m "feat: add amazing feature"
git push origin feature/amazing-feature

Then open a Pull Request 🚀

---

📖 License

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

---

🙏 Acknowledgments

• Charm — For the incredible Bubble Tea & Lip Gloss libraries
• K9s — For the design inspiration
• golangci-lint — For the Go linting ecosystem
• All our contributors ❤️

---

⭐ If you find devdash useful, give it a star!

Made with ❤️ and Go