mirrors/todo.txt-cli: ☑️ A simple and extensible shell script for managing your todo.txt file.

mirror of https://github.com/todotxt/todo.txt-cli.git synced 2026-01-08 15:07:10 +01:00

☑️ A simple and extensible shell script for managing your todo.txt file. http://todotxt.org

cli linux shell todo todoapp todo-cli todo-list todolist todos todotxt

Find a file

Ingo Karkat b20f9b45e2 BUG: Correct Bash completion path in Makefile Merge pull request #452 from inkarkat/451-fix-bash-completion		2024-12-29 11:55:23 +01:00
.github	Tests: Also execute installation, uninstallation, clean to test suite	2024-12-28 09:11:40 +01:00
tests	Tests: Add coverage for listing projects at various positions	2024-12-26 13:48:55 +01:00
.gitignore	Ignore user data.	2012-03-19 11:00:51 -05:00
CHANGELOG.md	Documentation: Update changelog	2024-12-29 10:35:28 +01:00
GEN-VERSION-FILE	Merge branch 'master' into a1346054-master	2024-12-27 07:51:24 +01:00
LICENSE	Minor fixes identified through shellcheck and other tools (#350 )	2021-08-09 15:03:49 -05:00
Makefile	FIX: Correct location for (dynamically sourced) locally installed completions	2024-12-29 10:30:34 +01:00
README.md	Documentation: Consistency: Mention CONFIG_DIR default, legacy location for completion	2024-12-29 10:30:34 +01:00
todo.cfg	todo.cfg: Cosmetics: Don't overload "parameters" (use "arguments"), drop trailing spaces	2024-12-26 12:32:13 +01:00
todo.sh	Merge branch 'master' into a1346054-master	2024-12-27 07:51:24 +01:00
todo_completion	Merge branch 'master' into a1346054-master	2024-12-27 07:51:24 +01:00
USAGE.md	Improved usage messages for actions (#402 )	2024-12-26 12:08:41 +01:00

README.md

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 $(brew --prefix)/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 the todo/config configuration template (default /usr/local/etc)
BASH_COMPLETION: PATH for autocompletion scripts (default to /usr/local/share/bash-completion/completions)

# Note: Showcasing config overrides for legacy locations; NOT recommended!
make install CONFIG_DIR=/etc INSTALL_DIR=/usr/bin BASH_COMPLETION=/etc/bash_completion.d

Arch Linux (AUR)

https://aur.archlinux.org/packages/todotxt/

Configuration

No configuration is required; however, most users tweak the default settings (e.g. relocating the todo.txt directory to a subdirectory of the user's home directory, or onto a cloud drive (via the TODO_DIR variable)), modify the colors, add additional highlighting of projects, contexts, dates, and so on. A configuration template with a commented-out list of all available options is included. It is recommended to copy that template into one of the locations listed by todo.sh help on -d CONFIG_FILE, even if it is installed in the global configuration location (/etc/todo/config).

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"

`replace`

Replaces task on line NR with UPDATED TODO.

todo.sh replace NR "UPDATED TODO"

`report`

Adds the number of open tasks and done tasks to report.txt.

todo.sh report

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.