Awesome

A simple and extensible shell script for managing your todo.txt file.

gif

Read our contributing guide if you're looking to contribute (issues/PRs/etc).

Installation

Download

Download the latest stable release for use on your desktop or server.

OS X / macOS

brew install todo-txt

# For macOS on x86 CPU 
cp -n /usr/local/opt/todo-txt/todo.cfg ~/.todo.cfg

# For macOS on arm CPU
cp -n /opt/homebrew/opt/todo-txt/todo.cfg ~/.todo.cfg

Note: The -n flag for cp makes sure you do not overwrite an existing file.

Linux

From command line

make
make install
make test

NOTE: Makefile defaults to several default paths for installed files. Adjust to your system:

INSTALL_DIR: PATH for executables (default /usr/local/bin)
CONFIG_DIR: PATH for the todo.txt configuration template
BASH_COMPLETION: PATH for autocompletion scripts (default to /etc/bash_completion.d)

make install CONFIG_DIR=/etc INSTALL_DIR=/usr/bin BASH_COMPLETION=/usr/share/bash-completion/completions

Arch Linux (AUR)

https://aur.archlinux.org/packages/todotxt/

Configuration

No configuration is required; however, most users tweak the default settings (e.g. relocating the todo.txt directory to a subdirectory of the user's home directory, or onto a cloud drive (via the TODO_DIR variable)), modify the colors, add additional highlighting of projects, contexts, dates, and so on. A configuration template with a commented-out list of all available options is included. It is recommended to copy that template into one of the locations listed by todo.sh help on -d CONFIG_FILE, even if it is installed in the global configuration location (/etc/todo/config).

Usage

todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]

For example, to add a todo item, you can do:

todo.sh add "THING I NEED TO DO +project @context"

Read about all the possible commands in the USAGE file.

Release History

See CHANGELOG.md

Support

Code of Conduct

Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributing

We welcome all contributions. First read our Contributor Code of Conduct and then get started contributing.