587833bb4e
When a user installs from a package manager (MacPorts, Homebrew, `yum`, etc.), the `todo.sh` script is installed into a restricted folder. This means that the result of `$(basename "$0")` is a directory where the user cannot write without elevated permissions. This generates additional noise when the user first runs `todo.sh -h`. An alternative is to default to the user's personal directory which is known to exist and will be writable by the user.
A simple and extensible shell script for managing your todo.txt file.
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
cp -n /usr/local/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 todo.txt configBASH_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/
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 contributations. First read our Contributor Code of Conduct and then get started contributing.
License
GNU General Public License v3.0 © todo.txt org