doneit-tui
v1.4.0
Published
A keyboard-driven terminal UI for task management
Maintainers
Readme
DoneIt
A keyboard-driven terminal UI for personal task and project management. Built for developers who live in the terminal.
Features
- Kanban-style layout - Three-column view (Todo | In Progress | Done)
- Vim-style navigation -
hjklkeys, no mouse required - Fast task capture - Add tasks in seconds without leaving the terminal
- Rich task properties - Priority, project, tags, due dates, and descriptions
- Powerful filtering - Search, filter by project, tags, or priority
- Persistent storage - Local JSON with automatic backups
- Cross-platform - Works on macOS, Linux, and Windows
Installation
npm install -g doneit-tuiThen run from anywhere:
doneitFrom Source
git clone https://github.com/felgeekpe/doneit-tui.git
cd doneit-tui
npm install
npm run build
npm linkUsage
Keyboard Shortcuts
Navigation
| Key | Action |
|-----|--------|
| j / ↓ | Move down |
| k / ↑ | Move up |
| h / ← | Previous column |
| l / → | Next column |
| g | Jump to top |
| G | Jump to bottom |
Task Actions
| Key | Action |
|-----|--------|
| n | New task |
| e / Enter | Edit task |
| d | Toggle done |
| m | Move to next status |
| ! | Cycle priority |
| x | Delete task |
Filters & Search
| Key | Action |
|-----|--------|
| / | Search tasks |
| p | Filter by project |
| Esc | Clear filters / Close modal |
General
| Key | Action |
|-----|--------|
| ? | Show help |
| q | Quit |
Task Properties
Each task can have:
- Title - Task name (required)
- Description - Detailed notes (Markdown supported)
- Status -
todo,in_progress,done, orarchived - Priority -
low,medium,high, orurgent - Project - Group tasks by project
- Tags - Flexible labels for categorization
- Due Date - Track deadlines
Data Storage
DoneIt stores your data locally in ~/.doneit/:
data.json- Your tasksbackups/- Automatic backups (keeps last 5)
Tech Stack
- React - UI framework
- Ink - React for CLI
- Zustand - State management
- TypeScript - Type safety
Development
# Watch mode (auto-rebuild on changes)
npm run dev
# Type checking
npm run typecheck
# Build
npm run buildContributing
Contributions are welcome! Please read the Contributing Guide for details.
License
MIT © Felipe Serna
