-
Notifications
You must be signed in to change notification settings - Fork 80
Home
Fabio Luciano edited this page Feb 19, 2026
·
20 revisions
Welcome to the PowerKit documentation. PowerKit is a comprehensive tmux status bar framework that provides 43 native plugins, external plugin support, 32 themes, and a contract-based architecture for extensibility.
PowerKit transforms your tmux status bar into an informative dashboard with real-time system metrics, development tool integrations, and productivity features. It uses a modern contract-based architecture that separates data collection from visual presentation.
| Requirement | Version | Notes |
|---|---|---|
| tmux | 3.0+ | 3.2+ recommended |
| Bash | 5.0+ | 5.1+ recommended for optimal performance |
| Font | Nerd Font | For icons and separators |
macOS users: macOS ships with Bash 3.x. Install Bash 5+ with
brew install bash.
- Installation - Setup guide for TPM and manual installation
- Quick Start - Get up and running in minutes
- Configuration - All configuration options
- Options Reference - Complete tmux.conf template
- Architecture Overview - How PowerKit works internally
- Caching System - Multi-layer cache for performance
- Plugin Contract - How plugins provide data and semantics
- Theme Contract - How themes define colors
- Helper Contract - How helpers provide UI interactions
- Session Contract - Session state representation
- Window Contract - Window state representation
- Pane Contract - Pane borders, flash effect, and sync indicator
- Developing Plugins - Create your own plugins
- Developing Helpers - Create interactive menus
- Developing Themes - Create custom themes
- Keybindings - Keybinding system and conflict resolution
- Plugins - All 43 native plugins + external plugins
- Available Themes - All 32 themes with 56 variants
- Global Helpers - System-wide helpers
- macOS Native Binaries - Native binaries for efficient metrics
- Troubleshooting - Common issues and solutions
See the Plugins page for complete documentation including external plugins.
| Category | Plugins |
|---|---|
| System | battery, cpu, memory, swap, disk, loadavg, uptime, temperature, fan, gpu, iops, hostname, volume |
| Network | netspeed, wifi, vpn, ping, external_ip, ssh, weather |
| Media | brightness, nowplaying, audiodevices, camera, microphone, bluetooth |
| Development | git, github, gitlab, bitbucket, jira, kubernetes, terraform, cloud, cloudstatus, packages |
| Productivity | datetime, timezones, pomodoro, bitwarden, smartkey |
| Financial | crypto, stocks |
| External | Custom plugins via external("icon"|"content"|"accent"|"accent_icon"|"ttl")
|