README
ΒΆ
Tasks - Terminal Markdown Task Manager
A beautiful, interactive terminal application for managing tasks stored in markdown files. Built with Go, Bubble Tea, and lipgloss for a modern TUI experience.
Yes, this has been vibe coded.

Features
- β¨ Interactive Terminal UI - Navigate with Vim-style keys including page navigation
- π Markdown Integration - Works with standard markdown task lists
- π³ Hierarchical Structure - Support for nested sections and tasks
- π¨ Beautiful Styling - Modern colors, typography, and consistent highlighting
- β‘ Live Editing - Create and edit tasks and sections in-place
- π Task Management - Toggle completion, move tasks, delete items, collapse sections
- π― Section Creation - Quick section creation with h+1 to h+6 shortcuts
- β¨ Smart Highlighting - Fixed-width highlighting that adapts to indentation
- ποΈ Global Section Control - Collapse/expand all sections at once
- π Unicode Support - Full support for international characters and emojis
- π Empty File Handling - Create tasks and sections in empty markdown files
Installation
Prerequisites
- Go 1.24.5 or later
Install with Go
go install dev.rischmann.fr/tasks@latest
Build from Source
git clone https://github.com/vrischmann/tasks
cd tasks
go build
Quick Start
-
Run with a markdown file:
tasks demo.md -
Try the included examples:
tasks demo.md # Complex hierarchical example tasks test.md # Simple test file -
Use with your own files:
tasks path/to/your/todo.md
Supported Markdown Format
The application works with standard markdown task lists:
# Project Tasks
## Frontend Development
- [ ] Setup React project
- [x] Create main components
- [ ] Implement routing
### UI Components
- [ ] Button component
- [ ] Form component
## Backend Development
- [x] API design
- [ ] Database setup
Controls
Navigation
| Key | Action |
|---|---|
j / β |
Move down |
k / β |
Move up |
Ctrl+F |
Page forward (down) |
Ctrl+B |
Page backward (up) |
q |
Quit application |
Task Management
| Key | Action |
|---|---|
space |
Toggle task completion (β/β) |
n |
Create new task |
e |
Edit current task or section |
d |
Delete current item (tasks or sections with all contents) |
Alt+j / Alt+β |
Move item down |
Alt+k / Alt+β |
Move item up |
Section Management
| Key | Action |
|---|---|
h+1 |
Create new h1 section (#) |
h+2 |
Create new h2 section (##) |
h+3 |
Create new h3 section (###) |
h+4 |
Create new h4 section (####) |
h+5 |
Create new h5 section (#####) |
h+6 |
Create new h6 section (######) |
Section Control
| Key | Action |
|---|---|
enter |
Toggle section expand/collapse |
β |
Collapse current section |
β |
Expand current section |
- |
Collapse all sections |
+ |
Expand all sections |
File Operations
| Key | Action |
|---|---|
s |
Save changes to file |
Input Mode
When creating or editing tasks/sections:
| Key | Action |
|---|---|
Enter |
Save and exit input mode |
Esc / Ctrl+C |
Cancel and exit input mode |
Backspace |
Delete characters |
Note: Full Unicode support - type accented characters (Γ©, Γ±, etc.) and emojis directly!
Examples
Creating a New Task
- Navigate to where you want to add a task
- Press
n - Type your task description
- Press
Enterto save
Creating a New Section
- Navigate to where you want to add a section
- Press
hfollowed by a number (1-6) for the section levelh+1creates# Section Nameh+2creates## Section Name- etc.
- Type your section name
- Press
Enterto save
Organizing with Sections
- Use markdown headers (
#,##,###) to create sections - Navigate to a section header and press
Enterto collapse/expand - Use
β/βfor quick collapse/expand - Collapsed sections hide all their sub-content
Editing Existing Items
- Navigate to the task or section you want to edit
- Press
e - Modify the text
- Press
Enterto save changes
Moving Items
- Use
Alt+jorAlt+βto move items down - Use
Alt+korAlt+βto move items up - Works for both tasks and sections
Deleting Items
- Navigate to the task or section you want to delete
- Press
d - The item is immediately deleted (no confirmation)
- For tasks: Only the task is deleted
- For sections: The section and ALL its contents (subsections, tasks) are deleted
Global Section Management
- Press
-to collapse all sections at once (overview mode) - Press
+to expand all sections at once (detailed mode) - Useful for quickly switching between high-level and detailed views
File Structure
tasks/
βββ main.go # Main application code (867 lines)
βββ go.mod # Go module definition
βββ go.sum # Go module checksums
βββ Justfile # Just build automation (optional)
βββ demo.md # Complex example file
βββ test.md # Simple example file
βββ README.md # This file
βββ CLAUDE.md # Developer documentation
βββ AGENTS.md # Agent configuration
βββ LICENSE # MIT License
Development
Requirements
- Go 1.24.5+
- Terminal with color support
Dependencies
- Bubble Tea - Terminal UI framework
- lipgloss - Styling and layout
Building
go mod download
go build
Using Just (alternative build tool)
If you have just installed:
just build # Build the application
just run # Run with test.md
just fmt # Format code
just check # Run vet and staticcheck
just watch-build # Watch and rebuild on changes
just watch-run # Watch and run on changes
Testing
go run main.go demo.md
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit a pull request
License
MIT License - see LICENSE file for details
Documentation
ΒΆ
There is no documentation for this package.
Click to show internal directories.
Click to hide internal directories.