HeyShinde/TermBoard
Contribute to HeyShinde/TermBoard development by creating an account on GitHub.
1 stars · 0 forks · 0 watchers
README
🎯 TermBoard A beautiful, interactive terminal dashboard for Python projects, environments, and tasks.
The Problem: "Why not just use a script?" As developers, we often write Makefiles or bash scripts (like test.sh or lint.sh) to manage our project workflows. While scripts work, they have severe limitations:
Context Switching: You have to remember the exact command or script name, type it out, and watch it vomit hundreds of lines of output into your terminal, erasing your history. Environment Hell: Did you remember to activate your virtual environment? Are you using uv, poetry, or conda? Running the wrong script in the wrong environment is a daily frustration. Discoverability: New developers joining your project don't know what scripts exist or what they do.
The Solution: TermBoard TermBoard replaces your scripts with a persistent, interactive Terminal UI (TUI).
🧠 Smart Environment Detection: TermBoard automatically detects if you are using uv, poetry, pipenv, or a standard .venv, and executes your tasks in the correct environment—no manual activation required. ⚡ Asynchronous Streaming: Tasks run asynchronously in the background. Their output is streamed directly into a beautiful, scrollable Rich Log window without freezing the UI or polluting your terminal history. 🛠️ Fully Customizable: Define custom tasks in a termboard.toml file. Your team can clone the repo, run termboard, and instantly have a UI with clickable buttons for deploying, testing, and building.
Features
Project Info: Instantly see your project's version, python requirements, and virtual environment status. Dependency Viewer: A clean data table of all your project's dependencies parsed directly from pyproject.toml. Dynamic Tasks Engine: Clickable buttons for your workflows (e.g., pytest, ruff) that execute asynchronously. In-App Settings: Override environment variables, add new custom tasks, and save configurations globally without leaving the terminal.
Installation TermBoard is designed to be installed globally on your machine so you can run it inside any Python project. Using uv (Recommended): uv tool install termboard Using pipx: pipx install termboard Quick Start Navigate to any Python project directory and simply type: termboard (If you don't have any custom tasks defined, TermBoard will automatically provide defaults for testing and linting).