Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/todotxt/todo.txt-cli

☑️ A simple and extensible shell script for managing your todo.txt file.
https://github.com/todotxt/todo.txt-cli

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

Last synced: 6 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/todotxt/todo.txt-cli
Owner: todotxt
License: gpl-3.0
Created: 2009-03-06T01:33:34.000Z (almost 16 years ago)
Default Branch: master
Last Pushed: 2024-12-29T10:55:24.000Z (15 days ago)
Last Synced: 2024-12-31T06:04:36.607Z (13 days ago)
Topics: cli, linux, shell, todo, todo-cli, todo-list, todoapp, todolist, todos, todotxt
Language: Shell
Homepage: http://todotxt.org
Size: 5.58 MB
Stars: 5,635
Watchers: 173
Forks: 716
Open Issues: 34
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-starred - todotxt/todo.txt-cli - ☑️ A simple and extensible shell script for managing your todo.txt file. (cli)
awesome-bash - todo.sh - A simple and extensible shell script for managing your todo.txt file. (Applications / Tools)
awesome - todotxt/todo.txt-cli - ☑️ A simple and extensible shell script for managing your todo.txt file. (Shell)
awesome-starred-test - todotxt/todo.txt-cli - ☑️ A simple and extensible shell script for managing your todo.txt file. (Shell)
awesome-note-taking - todo-txt - A simple and extensible shell script for managing your todo.txt file. (Open Source / CLI)
my-awesome - todotxt/todo.txt-cli - cli,todo-list,todoapp,todolist,todos,todotxt pushed_at:2024-10 star:5.6k fork:0.7k ☑️ A simple and extensible shell script for managing your todo.txt file. (Shell)

README

        # [![todo.txt-cli](http://todotxt.org/images/todotxt_logo_2012.png)][website]

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

![CI](https://github.com/todotxt/todo.txt-cli/workflows/CI/badge.svg)

[![GitHub issues](https://img.shields.io/github/issues/todotxt/todo.txt-cli.svg)](https://github.com/todotxt/todo.txt-cli/issues)

[![GitHub forks](https://img.shields.io/github/forks/todotxt/todo.txt-cli.svg)](https://github.com/todotxt/todo.txt-cli/network)

[![GitHub stars](https://img.shields.io/github/stars/todotxt/todo.txt-cli.svg)](https://github.com/todotxt/todo.txt-cli/stargazers)

[![GitHub license](https://img.shields.io/github/license/todotxt/todo.txt-cli.svg)](https://raw.githubusercontent.com/todotxt/todo.txt-cli/master/LICENSE)

[![Gitter](https://badges.gitter.im/join_chat.svg)](https://gitter.im/todotxt/todo.txt-cli)

![gif](./.github/example.gif)

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

## Installation

### Download

Download the latest stable [release][release] for use on your desktop or server.

### OS X / macOS

```shell

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

```shell

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`)

```shell

# 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

```shell

todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]

```

For example, to add a todo item, you can do:

```shell

todo.sh add "THING I NEED TO DO +project @context"

```

### `replace`

Replaces task on line NR with UPDATED TODO.

```shell

todo.sh replace NR "UPDATED TODO"

```

### `report`

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

```shell

todo.sh report

```

Read about all the possible commands in the [USAGE][USAGE] file.

## Release History

See [CHANGELOG.md][CHANGELOG]

## Support

- [Github Discussions](https://github.com/todotxt/todo.txt-cli/discussions)

- [Stack Overflow](https://stackoverflow.com/questions/tagged/todotxt)

- [Twitter](https://twitter.com/todotxt)

## Code of Conduct

[Contributor Code of Conduct][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][CODE_OF_CONDUCT] and then get started [contributing][CONTRIBUTING].

## License

GNU General Public License v3.0 © [todo.txt org][github]

[release]: https://github.com/todotxt/todo.txt-cli/releases

[website]: http://todotxt.org/

[github]: https://github.com/todotxt

[USAGE]: ./USAGE.md

[CHANGELOG]: ./CHANGELOG.md

[CODE_OF_CONDUCT]: .github/CODE_OF_CONDUCT.md

[CONTRIBUTING]: .github/CONTRIBUTING.md