@@ -22,45 +22,67 @@ export PATH="$HOME/.local/bin:$PATH"
2222Start using it:
2323
2424``` sh
25- tody add " Buy groceries" # global task
26- tody add " Fix login bug" --local # task scoped to this project
27- tody # interactive picker
28- tody list # print pending tasks
25+ tody add " Buy groceries" # global task (when not in a project)
26+ cd ~ /projects/my-app
27+ tody add " Fix login bug" # auto-detected as local (you're in a git repo)
28+ tody add " Read docs" --global # explicitly global, even inside a project
29+ tody # interactive picker scoped to current project
30+ tody list # pending tasks for current project
31+ tody list --global # pending global tasks only
32+ tody list --all # everything across all projects
33+ tody list --done # completed tasks
2934```
3035
31- ## Most-used commands
32-
33- | Command | Description |
34- | ---------| -------------|
35- | ` tody ` | Interactive picker to mark a task done |
36- | ` tody add <title> ` | Add a task (` -l ` / ` --local ` for project scope) |
37- | ` tody list ` | List tasks (` -g ` , ` -l ` , ` -a ` ) |
38- | ` tody done <id> ` | Mark task as completed |
39- | ` tody rm <id> ` | Delete task (with confirmation) |
40- | ` tody log ` | Show recently completed tasks |
41- | ` tody prune ` | Remove tasks tied to deleted folders |
42- | ` tody update ` | Self-update from GitHub releases |
36+ ## Command quick guide
37+
38+ | If you want to... | Run | Result |
39+ | -------------------| -----| --------|
40+ | complete a task from a picker | ` tody ` | interactive prompt scoped to current project |
41+ | add a task (auto-scoped) | ` tody add "Title" ` | local when in a git repo, global otherwise |
42+ | add an explicitly global task | ` tody add "Title" -g ` | task is visible everywhere |
43+ | add an explicitly local task | ` tody add "Title" -l ` | task is tied to the current project |
44+ | see this project's tasks | ` tody list ` | local tasks for the current project only |
45+ | see global tasks | ` tody list -g ` | global tasks only |
46+ | see everything | ` tody list -a ` | all tasks across all projects |
47+ | see completed tasks here | ` tody list -d ` | completed tasks scoped to current context |
48+ | see all completed tasks | ` tody list -a -d ` | all completed tasks across projects |
49+ | mark a task completed by id | ` tody done <id> ` | marks one task as done |
50+ | edit a task's title | ` tody edit <id> "New title" ` | updates the task title |
51+ | undo the last completion | ` tody undo ` | restores the last completed task to pending |
52+ | permanently delete a task | ` tody rm <id> ` | removes one task after confirmation |
53+
54+ Other useful commands:
55+
56+ - ` tody log ` : recently completed activity (project-scoped by default)
57+ - ` tody log --all ` : completed activity across all projects
58+ - ` tody prune ` : remove tasks tied to deleted folders
59+ - ` tody update ` : self-update from GitHub releases
4360
4461## What it does
4562
46- - ** Path-aware** : Local tasks are tied to your current project root.
63+ - ** Project-scoped by default** : Inside a git repo, tasks are automatically local to that project.
64+ - ** Smart auto-detection** : No flags needed — ` tody add ` and ` tody list ` just work in context.
4765- ** Zero config** : Works immediately with a local SQLite database.
4866- ** Single binary** : No runtime dependencies.
4967- ** Fast CLI flow** : Interactive picker plus explicit commands.
68+ - ** Developer-friendly** : ` edit ` , ` undo ` , project-scoped ` log ` .
5069
5170## Scope model
5271
5372Every task is either:
5473
55- - ** Global** : visible from any folder.
56- - ** Local** : tied to a project path (nearest git root, or ` cwd ` fallback).
74+ - ** Global** : visible from any folder. Created with ` -g ` flag, or auto-detected outside a git repo.
75+ - ** Local** : tied to a project path (nearest git root). Auto-detected when inside a git repo.
76+
77+ When you ` cd ` into a project and run ` tody ` , you only see that project's tasks.
78+ Use ` tody list -g ` for global tasks, or ` tody list -a ` to see everything.
5779
5880## Configuration
5981
6082Config file (macOS/Linux): ` ~/.config/tody/config.toml `
6183
6284``` toml
63- default_view = " merged " # merged | local | global
85+ default_view = " auto " # auto | merged | local | global
6486color_local = " bright_magenta" # ANSI color name
6587color_global = " bright_cyan" # ANSI color name
6688```
0 commit comments