Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Quick Start Guide
Here's how to install and run the Todo.txt CLI:
(Windows only) Download and install Cygwin. Cygwin provides a Unix-environment for Windows; Todo.txt needs just the Bash shell and some common Unix tools, so a minimal installation will do just fine (Another suggestion is to use git on windows - it's smaller and have sh builtin git on windows).
Download the latest stable release of Todo.txt CLI (available as a ZIP or TAR archive) and extract it. Mac users: There is a Homebrew package for todo.txt - install using
brew install todo-txt.
Open a command window. On Windows, this is Cygwin Bash Shell (not Command Prompt!); elsewhere, this is often called Terminal. It usually presents you with a
cdinto the directory where you extracted todo.sh. Make the todo.sh script executable:
$ chmod +x todo.sh
./todo.shto see the usage message. You're ready to go! To start adding tasks, type
./todo.sh add "My new task"
- Install the Bash completion, either system-wide, for all users:
$ sudo cp todo_completion /etc/bash_completion.d/todo
or put it somewhere in your home directory and source it from your
$ source todo_completion
Now you can type
$ ./todo.sh ad<Tab> and Bash will autocomplete the action to
$ ./todo.sh add. Any words that begin with + or ` will be completed using projects or contexts, respectively. Task numbers will append the task text as a shell comment.
Note: If you define an alias (e.g.
t) to todo.sh, you need to explicitly enable completion for it, too (also put this into your
$ complete -F _todo t
Want more? See the full list of configuration tweaks, enhancements and recommendations on the [Tips and Tricks][Tips-and-Tricks] page.
Something missing? Todo.txt is extensible; many users have already written [custom add-ons][Todo.sh-Add-on-Directory].