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

Table of Contents

• Introduction
• Installation
  • Prerequisites
  • Download
  • OS X / macOS
  • Linux
  • Arch Linux (AUR)
• Usage
• Release History
• Support and Community
• Code of Conduct
• Contributing
• License

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

Introduction

todo.txt-cli is a simple and extensible shell script for managing your todo.txt file. It provides an efficient way to keep track of your tasks using a plain text file.

Installation

Before you begin, make sure you have the following installed:

• [List of prerequisites or dependencies]

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

• Github Discussions
• Stack Overflow
• Twitter

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