Command-line todo.txt manager.
Early implementation stage.
The tada command operates on files called "todo.txt" and "done.txt"
in your home directory by default. These should be formatted using the
todo.txt format; one task per line.
Empty lines are allowed, and lines starting with "#" are ignored as comments.
You can use environment variables TODO_FILE and DONE_FILE to point
to different files, or use command-line flags for the same. The TODO_DIR
environment variable also exists and affects both files.
Tada usually categorizes tasks along three main vectors:
People often confuse urgency with importance. Watching a football match on TV
might be urgent because the game starts in ten minutes, but it's probably not
all that important. Filing your taxes might not be urgent, but because the
consequences of not doing it are dire, it's important. Importance is indicated
by setting a priority capital (A) to (E). (Letters after E are allowed,
but will be treated as essentially equivalent.)
Due dates are indicated by including due:YYYY-MM-DD in the task description,
and urgency will be calculated based on how soon the due date is, or if it is
overdue. It is also possible to set start dates on tasks using
start:YYYY-MM-DD. Tasks will be shown greyed out until that date.
(All dates are just dates, not datetimes.)
Tshirt size is indicated by marking the task with @S, @M, or @L. As a
rough guide, tasks under an hour might be small, tasks under a day might be
medium, and anything else might be large. But you know better than I how big
your tasks normally are, so different thresholds may make sense for you. Tada
doesn't make any assumptions about how big @S, @M, and @L are in terms
or minutes, hours, or days; just that those three sizes exist. Tags like
@XS and @XXL are allowed, but will be treated as synonyms for @S and
@L.
```text A todo list manager
Usage: tada
Commands: add Add a task to the todo list remove Remove a task or tasks edit Open your todo list in your editor pull Reschedule a task or tasks to be done today (or another date) done Mark a task or tasks as done find Search for a task show Show the full todo list important Show the most important tasks urgent Show the most urgent tasks quick Show the smallest tasks archive Move completed tasks from todo.txt to done.txt tidy Remove blank lines and comments from a todo list zen Automatically reschedule overdue tasks help Print this message or the help of the given subcommand(s)
Options: -h, --help Print help information -V, --version Print version information ```
The shortcuts tada i, tada u, and tada q can be used to show important,
urgent, and quick tasks.
The shortcuts tada +project, tada @context, and tada #linenumber
can be used as shortcuts for finding projects by project, context, and
line number.
```text Add an item to the todo list
Usage: tada add [OPTIONS] [task]
Arguments: [task] Task text (may use todo.txt features)
Options:
-f, --file
After success, displays the added task. ```
```text Remove a task or tasks
Usage: tada remove [OPTIONS]
Arguments:
Options:
-f, --file
```text Open your todo list in your editor
Usage: tada edit [OPTIONS]
Options:
-f, --file
Ensure the EDITOR environent variable is set. ```
```text Reschedule a task or tasks to be done today (or another date)
Usage: tada pull [OPTIONS]
Arguments:
Options:
-f, --file
If a task has a start date, that will be set to today. ```
```text Mark a task or tasks as done
Usage: tada done [OPTIONS]
Arguments:
Options:
-f, --file
```text Search for a task
Usage: tada find [OPTIONS]
Arguments:
Options:
-f, --file
Multiple search terms may be provided, which will be combined with an 'AND' operator.
Searches are case-insensitive. ```
```text Show the full todo list
Usage: tada show [OPTIONS]
Options:
-f, --file
```text Show the most important tasks
Usage: tada important [OPTIONS]
Options:
-f, --file
Ignores tasks which are marked as already complete or have a start date in the future. ```
```text Show the most urgent tasks
Usage: tada urgent [OPTIONS]
Options:
-f, --file
Ignores tasks which are marked as already complete or have a start date in the future. ```
```text Show the smallest tasks
Usage: tada quick [OPTIONS]
Options:
-f, --file
Ignores tasks which are marked as already complete or have a start date in the future. ```
```text Move completed tasks from todo.txt to done.txt
Usage: tada archive [OPTIONS]
Options:
-f, --file
```text Remove blank lines and comments from a todo list
Usage: tada tidy [OPTIONS]
Options:
-f, --file
This is the only command which will renumber tasks in your todo list. ```
```text Automatically reschedule overdue tasks
Usage: tada zen [OPTIONS]
Options:
-f, --file
Zen will reschedule any overdue tasks on your todo list. It does not consult you to ask for a new due date, but guesses when a sensible due date might be. ```
Exactly how zen works is subject to change, but it will aim to reschedule tasks which are both small and important to be done first, then tasks which are either small or important, and finally larger and less important tasks. It will only reschedule tasks which are already overdue and not finished.
It is possible to set TADA_FILE or the --file option to an HTTP or HTTPS
URL. It performs GET requests to read the file and PUT to write to it.
The TADA_HTTP_USER_AGENT, TADA_HTTP_AUTHORIZATION, and TADA_HTTP_FROM
environment variables may be used to perform some very rudimentary
authentication if the server at the other end of the request is set up
right. See php-tada-server
for an example.
As mentioned above, todo files are expected to be in the
todo.txt format. Lines consisting
of just whitespace are ignored. Lines beginning with # are treated as
comments and ignored.
tada recognizes the following special tags in descriptions:
@S, @M, and @L contexts are used to indicate whether a task is small, medium, or large.@work or @school, it will avoid being automatically rescheduled onto Saturdays or Sundays.due:YYYY-MM-DD sets a due date for a task.start:YYYY-MM-DD sets a start date for a task.This project is triple licensed under the Apache License, version 2.0, the MIT License, and the GNU General Public License, version 2.0.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion into this project by you, shall be triple licensed as Apache-2.0/MIT/GPL-2.0, without any additional terms or conditions.