Skip to content

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

License

Notifications You must be signed in to change notification settings

prakhargahlot/todo.txt-cli

 
 

Repository files navigation

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

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)
  • TODO_DIR: PATH for the pre-existing todo.txt, done.txt and report.txt files.
make install CONFIG_DIR=/etc INSTALL_DIR=/usr/bin BASH_COMPLETION=/usr/share/bash-completion/completions TODO_DIR=/home/user/cloud/todo

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

About

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

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 98.7%
  • Makefile 1.3%