Skip to content

anduimagui/2dui

Repository files navigation

2dui

2dui is a small command-line tool for project todos and checklist items.

It installs the 2do command.

What It Does

  • Finds todo.yml, todo.yaml, 2do.yml, and 2do.yaml files.
  • Lists tasks from the current folder, nested folders, and parent folders.
  • Adds, completes, removes, prioritizes, tags, and schedules tasks.
  • Stores reminder metadata in the todo file.
  • Validates todo files and checklist files.
  • Compares nested checklist rows, such as which provider has the most checked boxes.

Install

git clone https://github.com/anduimagui/2dui.git
cd 2dui
python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"

Install globally with pipx:

pipx install git+https://github.com/anduimagui/2dui.git

Common Commands

2do files
2do list
2do list -a -p
2do list --format json

2do create
2do add "Write docs" -p 3 --deadline 2026-07-15 --tags docs
2do done "Write docs"
2do remove "Write docs"

2do remind "Write docs" --at tomorrow-9am
2do reminders list
2do reminders check
2do reminders sync

Use another folder as the scan root:

2do --path /path/to/project list

Checklists

Validate a todo or checklist file:

2do validate todo.yml
2do validate provider-requirements-checklist.md --rank-providers

Compare nested checklist rows:

2do compare provider-requirements-checklist.md

Checklist comparison expects top-level checklist items with nested rows:

- [ ] Can survey roof.
  - [x] Alpha Solar
  - [ ] Beta Solar

Only checked nested rows count toward comparison totals.

Todo File Format

title: Project Todos
tasks:
  - name: Write documentation
    description: Update the README
    done: false
    priority: 3
    deadline: 2026-07-15
    tags: [docs]

Useful task fields:

  • name
  • description
  • done
  • priority from 1 most important to 10 least important
  • deadline as YYYY-MM-DD
  • tags
  • reminder

Development

python -m pytest
ruff check .

License

MIT

About

A small CLI for project todos and checklist items.

Resources

License

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors