morsecodemedia/todo
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Repository files navigation
TODO(1) General Commands Manual TODO(1)
NAME
todo - a minimalist todo list manager
SYNOPSIS
todo [--json] [-jvhexu] [-a "todo item"] [-d todo-number] [-d "todo
phrase"]
DESCRIPTION
todo is a simple, minimalist todo list manager. Users can add items to
a todo list or delete them. Deleted items are archived and can be re‐
viewed.
Displayed output is automatically sorted by priority and then by inser‐
tion order. Any todo item whose first token is P1 through P9 is treated
as prioritized, with lower numbers shown first.
The default location of the todo list can be set with the TODO environ‐
ment variable. If unset, the default file is ~/todo.txt.
If todo is used within a tmux session, the filename of the todo list
inherits the name of the current session. This allows for unique todo
lists based on tmux context.
The options are as follows:
no parameters
If no parameters are passed to todo, then the current todo list
will be displayed to standard out.
-a quoted_todo_item
Add a new todo list item
-d item_number_or_phrase
Delete a todo list item by its number or by a string. If a
string is provided, any todo list item that matches that string
will be removed. Deleted items are moved to the archive when op‐
erating on the main todo list.
-u Restore the most recent archived todo item back into the current
todo list.
The archive file is named identically to the todo file with the excep‐
tion of a .archive added before the extension. For example, todo.txt
would have an archive named todo.archive.txt in the same folder.
-x Use archive context. With no additional action, todo -x shows
the archive list. With other actions, operations apply to the
archive file instead of the main todo file. Deleting in archive
context (todo -xd ...) removes items permanently and does not
archive them elsewhere.
-j, --json
Display list output as JSON. This applies to both the current
todo list and archive view (-x).
-e Open the todo file in your editor.
-v Display current version information.
-h Show the help.
EXIT STATUS
The todo utility exits 0 on success, and >0 if an error occurs.
EXAMPLES
todo Displays the current todo list
todo -a "this is a new todo list item"
Adds a new item to the current todo list
todo -a P1 file taxes
Adds a prioritized todo item
todo -d 3
Deletes item #3 from the current todo list
todo -u
Restores the most recently archived todo item
todo -xe
Opens the archive file in your editor
todo -xd 3
Deletes item #3 from the archive file
todo -j
Displays the current todo list as JSON
todo -x
Shows the archive for the current todo list
LICENSE
GNU General Public License v3.0 or later at https://www.gnu.org/li‐
censes/gpl-3.0-standalone.html
BUGS
Report issues at the git repository at https://github.com/jamestom‐
asino/todo
AUTHOR
James Tomasino <james (at) tomasino (dot) org>
2026.04.23 23 April 2026 TODO(1)
Releases
No releases published
Languages
- Shell 59.8%
- Roff 23.3%
- Makefile 16.9%