Repository files navigation

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

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

Download the latest stablerelease for use on your desktop or server.

brew install todo-txtcp -n$(brew --prefix)/opt/todo-txt/todo.cfg~/.todo.cfg

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

makemake installmaketest

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 thetodo/config configuration template (default/usr/local/etc)
• BASH_COMPLETION: PATH for autocompletion scripts (default to/usr/local/share/bash-completion/completions)

# Note: Showcasing config overrides for legacy locations; NOT recommended!make install CONFIG_DIR=/etc INSTALL_DIR=/usr/bin BASH_COMPLETION=/etc/bash_completion.d

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

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 theTODO_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 tocopy that template into one of the locations listed bytodo.sh help on-d CONFIG_FILE, even if it is installed in the global configuration location (/etc/todo/config).

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"

Replaces task on line NR with UPDATED TODO.

todo.sh replace NR"UPDATED TODO"

Adds the number of open tasks and done tasks to report.txt.

todo.sh report

Read about all the possible commands in theUSAGE file.

SeeCHANGELOG.md

• Github Discussions
• Stack Overflow
• Twitter

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

We welcome all contributions. First read ourContributor Code of Conduct and then get startedcontributing.

GNU General Public License v3.0 ©todo.txt org