A simple and extensible shell script for managing your todo.txt file.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Ali Karbassi ea32af34e6
Updated GitHub Actions Environments (#372)
1 year ago
.github Updated GitHub Actions Environments (#372) 1 year ago
tests Minor fixes identified through shellcheck and other tools (#350) 1 year ago
.gitignore Ignore user data. 11 years ago
CHANGELOG.md Minor fixes identified through shellcheck and other tools (#350) 1 year ago
GEN-VERSION-FILE Minor fixes identified through shellcheck and other tools (#350) 1 year ago
LICENSE Minor fixes identified through shellcheck and other tools (#350) 1 year ago
Makefile Minor fixes identified through shellcheck and other tools (#350) 1 year ago
README.md Different folder to copy ~/.todo.cfg for macOS on arm/x86 CPU (#369) 1 year ago
USAGE.md Minor fixes identified through shellcheck and other tools (#350) 1 year ago
todo.cfg Default to user writable directory in config (#148) 1 year ago
todo.sh Minor fixes identified through shellcheck and other tools (#350) 1 year ago
todo_completion Minor fixes identified through shellcheck and other tools (#350) 1 year ago

README.md

todo.txt-cli

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

CI GitHub issues GitHub forks GitHub stars GitHub license Gitter

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 todo.txt config
  • 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/

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.

License

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