Skip to content

Repository files navigation

📋 Kanban TUI

Kanban TUI Social Preview

CI License: MIT Python 3.10+ Ruff Pre-commit

Elevate your productivity without ever leaving the terminal. A sleek, high-performance Kanban board designed for power users who live in the shell.


  • ⚡ Blazing Fast: Built with Python and Textual for a smooth, reactive TUI experience.
  • ⌨️ Vim-Style Navigation: Navigate your board with classic h/j/k/l keys.
  • 🔍 Power Search: Real-time filtering with support for #tags.
  • 💾 Local First: SQLite-backed persistence—your data stays on your machine.
  • 🎨 Premium Aesthetics: Modern design with vibrant colors, tall borders, and deep styling.
  • 🛠️ Professional Tooling: Full CI/CD suite, Ruff linting, and automated testing included.

🚀 Quick Start

1. Installation

# Clone the repository
git clone https://github.com/yourusername/kanban-tui.git
cd kanban-tui

# Create and activate environment
python -m venv venv
# On Windows:
.\venv\Scripts\activate
# On Unix:
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

2. Launch the Application

python src/app.py

⌨️ Controller Bindings

Key Action
h / l Move between columns (Todo, Doing, Done)
j / k Navigate through tasks in a column
n New Create a new task
e / Enter Edit modify the selected task
d / Del Delete remove the selected task
> / < Rotate move a task to the next/prev status
f / / Focus Search filter by title, description, or #tags
Tab Cycle through columns
? Help open the shortcut overlay
q Quit exit the application

🛠️ Development & Quality

This project is built to professional standards. To ensure code quality before pushing:

# Run linting (Ruff)
ruff check .

# Run tests (Pytest)
pytest

# Install pre-commit hooks
pre-commit install

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md and our CODE_OF_CONDUCT.md for details.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

Distributed under the MIT License. See LICENSE for more information.


⭐ If this project helps you, please give it a star!

About

A sleek, high-performance terminal-based Kanban board with SQLite persistence, Vim-style navigation, and real-time tag filtering.

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages