A rich CLI todo app with project management and task tagging
Project description
Todo CLI
A powerful command-line interface todo application with project management features, time tracking, and rich terminal output that plays well with git repos and aims to keep in the flow without the need of juggling between external services.
Motivation / Executive Summary
Efficient task management is essential for productivity in any project. This tool provides a simple, local, and git-friendly way to track todos directly within your project directory. By keeping your todo list version-controlled and out of your repository with .gitignore, you can maintain focus and organization without cluttering your codebase or relying on external services, in line with our spirit to enhance productivity and flow at Flowistic.
Features
Project Management
- Project-based task organization with custom prefixes
- Automatic task numbering (e.g., PROJ-001)
- Local todo lists (per directory)
Task Management
- Interactive task creation
- Task types (feature, bugfix, docs, test, refactor, chore) with color coding
- Priority levels (high, medium, low) with color coding
- Due dates with natural language support ("tomorrow", "next friday")
- Task completion tracking
- Rich terminal output with detailed task information
- Task notes with chronological history
- Update task properties after creation
- Set and track the status of tasks with full history.
- Update status via CLI (
todo update status <task_id> <status>). - Repeatable Tasks: You can make tasks repeat automatically by specifying a repeat rule in natural language (e.g., "every day", "every week"). When a repeatable task is completed, it is automatically reopened with a new due date based on the rule.
Time Tracking
- Built-in Pomodoro-style timer (default: 25 minutes)
- Customizable work session durations
- Work session history per task
- Interruption tracking
- Total time worked statistics
Project Analytics
- Comprehensive project status dashboard
- Task completion rates
- Priority distribution
- Due date statistics
- Work session analytics
- Time tracking summary
Visual Board (Trello-like)
You can visualize your tasks in a Trello-like web board using Dash:
todo board
This command launches a local Dash web app (requires Dash 3.x+ and [dash-bootstrap-components]) displaying your tasks as cards in columns by status (Pending, Completed, Cancelled). Each card shows:
- Title (with status badge)
- Task type and priority (color-coded badges)
- Task ID
- Due date
- Tags (as badges)
New:
- The board now features interactive filter controls at the top for Status, Type, and Due Date. You can select multiple options in each filter to dynamically filter the displayed tasks. The filters are styled for clarity and compactness, making it easy to focus on specific subsets of your tasks.
The board uses modern styling for easy scanning and prioritization. The app opens automatically in your browser at http://127.0.0.1:8050/. The browser tab and header will display "Flowistic Task Board".
Note: If you haven't installed Dash, add it via your environment manager:
uv pip install dash dash-bootstrap-components dash-mantine-components
Installation
pip install flowistic-todo
Usage
Initialize a Project
todo init
Follow the prompts to set:
- Project name
- Project description
- Task prefix (e.g., "PROJ" for PROJ-001)
If the current directory is a git repository, todo.yaml will be automatically added to .gitignore.
Add a Task
todo add
You'll be prompted for:
- Task title
- Description (optional)
- Type (feature/bugfix/docs/test/refactor/chore)
- Priority (low/medium/high)
- Due date (optional, supports natural language)
- Initial note (optional)
- Repeat rule (optional, e.g., "every week")
Add a Repeatable Task
todo add
# You will be prompted for repeat rule (e.g., every week)
Update Repeat Rule
todo update repeat <task_id> "every month"
List Tasks
todo list
Shows a table with:
- Task ID (e.g., PROJ-001)
- Type (color-coded by category)
- Title
- Priority (color-coded)
- Due date status
- Time worked
- Completion status
- Number of notes
Show Task Details
todo show PROJ-001
Shows detailed information about a specific task:
- Task title and task ID
- Task type
- Status and priority
- Description
- All notes in chronological order
- Due date with status
- Work session history
- Creation date
Manage Task Notes
todo note add PROJ-001 "Note text" # Add a new note
todo note add PROJ-001 # Add note with interactive prompt
todo note reset PROJ-001 # Clear all notes (with confirmation)
Update Task Properties
# Update task type
todo update type PROJ-001 feature # Set type directly
todo update type PROJ-001 # Interactive prompt
# Update task priority
todo update priority PROJ-001 high # Set priority directly
todo update priority PROJ-001 # Interactive prompt
# Update due date
todo update due PROJ-001 "next friday" # Set due date directly
todo update due PROJ-001 clear # Remove due date
todo update due PROJ-001 # Interactive prompt
# Update title
todo update title PROJ-001 "New title" # Set title directly
todo update title PROJ-001 # Interactive prompt
# Update description
todo update description PROJ-001 "New description" # Set description directly
todo update description PROJ-001 # Interactive prompt
# Update status
todo update status PROJ-001 pending # Set status directly
todo update status PROJ-001 # Interactive prompt
Evolve Task Status
You can move a task to the next workflow status using the evolve command:
todo evolve <task_id>
- Workflow order:
pending→doing→completed→cancelled - If the task is already at the last status (
cancelled), it will remain there and you will be notified. - The command updates the task status, marks as completed if appropriate, and appends to the status history.
Example:
todo evolve PROJ-001
This will move the task PROJ-001 to the next status in the workflow.
Task Cancellation & Deletion
todo cancel <task_id>: Mark a task as cancelled. The task remains in your list but its status is shown as cancelled in bothlistandshowcommands.- Example:
todo cancel PROJ-001
- Example:
todo delete <task_id>: Permanently remove a task from your todo list. This action cannot be undone.- Example:
todo delete PROJ-002
- Example:
Cancelled tasks are excluded from project completion statistics and are clearly indicated in task listings.
Work on a Task
todo workon PROJ-001 # Start a 25-minute work session
todo workon PROJ-001 -d 45 # Start a 45-minute work session
Features:
- Interactive progress bar
- Time tracking
- Session history
- Graceful interruption handling (Ctrl+C)
View Project Status
todo status
Shows:
- Project information
- Task completion rates
- Priority distribution
- Due date statistics
- Work session analytics
- Time tracking summary
Complete a Task
todo complete PROJ-001
Get Help
todo help # Show all commands
todo help <command> # Show detailed help for a specific command
Add and Remove Tags
You can add or remove tags from a task using the following commands:
Add a Tag
todo add-tag <task_id> <tag>
- Adds the specified tag to the task if not already present.
- Example:
todo add-tag PROJ-001 urgent
Remove a Tag
todo remove-tag <task_id> <tag>
- Removes the specified tag from the task if it exists.
- Example:
todo remove-tag PROJ-001 urgent
Commands
add: Add a new taskadd-tag <task_id> <tag>: Add a tag to a taskboard: Visualize tasks in a Trello-like web boardcancel <task_id>: Mark a task as cancelledcomplete <task_id>: Mark a task as completeddelete <task_id>: Permanently remove a task from your todo listevolve <task_id>: Move a task to the next workflow status (pending → doing → completed → cancelled)help: Show all commands or detailed help for a specific commandinit: Initialize a new projectlist: List all tasksnote add <task_id> [note]: Add a new note to a tasknote reset <task_id>: Clear all notes from a taskremove-tag <task_id> <tag>: Remove a tag from a taskshow <task_id>: Show detailed information about a taskstatus: Show project statusupdate description <task_id> [description]: Update the description of a taskupdate due <task_id> [due_date]: Update the due date of a taskupdate priority <task_id> [priority]: Update the priority of a taskupdate repeat <task_id> [repeat_rule]: Update the repeat rule of a taskupdate status <task_id> [status]: Update the status of a taskupdate title <task_id> [title]: Update the title of a taskupdate type <task_id> [type]: Update the type of a taskworkon <task_id> [-d duration]: Start a work session on a task
Changelog
v0.2.0 (2025-05-03)
- Feature: You can now set the status of a task (pending, doing, completed, cancelled).
- All status changes are tracked in a per-task history (visible with
todo show <task_id>). - Repeatable tasks: Add a repeat rule in natural language ("every week", "every month"). When completed, task is automatically reopened with next due date.
v0.2.1 (2025-05-04)
- Added repeatable task feature: tasks can be set to repeat automatically based on a natural language rule.
Configuration
The app stores tasks in YAML format:
todo.yamlis always created in the directory where thetodo initcommand is run.- There is no fallback to a user-level
.todo.yamlin the home directory; all data is project-local. - If in a git repository,
todo.yamlis automatically added to.gitignore(the file is created if it doesn't exist).
Task Storage Format
project:
name: "My Project"
description: "Project description"
prefix: "PROJ"
next_task_number: 1
tasks:
- task_id: "PROJ-001"
title: "Task title"
status: "pending"
status_history:
- status: "pending"
timestamp: "2025-05-03T10:00:00"
repeat: "every week" # Optional, natural language
due_date: "2025-05-10T23:59:59"
...
Running Tests
This project uses pytest for testing and uv for environment management. To run all tests:
uv pip install -r requirements.txt
uv pytest
If you encounter import errors or tests are not discovered:
- Make sure you are in the project root directory.
- Ensure
pytestis installed in your uv environment. - If you see import errors related to
todo, try:PYTHONPATH=. uv pytest
Test files are located in the tests/ directory and cover both core logic and CLI commands.
Development
- Clone the repository
- Install dependencies:
pip install -r requirements.txt
- Run the CLI:
python -m todo.cli
License
MIT License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file flowistic_todo-0.2.1.tar.gz.
File metadata
- Download URL: flowistic_todo-0.2.1.tar.gz
- Upload date:
- Size: 24.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ecfe2c6ef2fcf2131f797bfeda4eafc47d52fd5a44f2ac479a0fc1551dc2e790
|
|
| MD5 |
d5a8fdc581d0d9e6b9b8a4cd980afb79
|
|
| BLAKE2b-256 |
d66116e8b88e36dea3d9f4b7ae52960f3955970d549b7e66d7e178dbe8e1d021
|
File details
Details for the file flowistic_todo-0.2.1-py3-none-any.whl.
File metadata
- Download URL: flowistic_todo-0.2.1-py3-none-any.whl
- Upload date:
- Size: 23.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a9136e789ba970fb43a9bef02927e16f5bfe08befa278586fe6ad9e2503fae8
|
|
| MD5 |
3aa50fa8160d967abbd347fce7253551
|
|
| BLAKE2b-256 |
a15381bdf1a5e3b56d8617e40017dbb252830d0cb31eeff6d64dfe317ff20887
|