todo-txt-cli/README.md

A CLI for todo.txt files - http://todotxt.org/

[![npm-badge][npm-badge]][npm]
![types-badge][types-badge]

# todo.txt CLI

> A CLI for todo.txt files - See <http://todotxt.org/>

This project is a JavaScript implementation of a *todo.txt* CLI, allowing you to
manage your todo items in plain text files.

## Supported Syntax

The project follows and parses the syntax described on [todo.txt GitHub
page][todo.txt Syntax]. This includes:

- Tasks: `+task description`
- Projects: `+project`
- Contexts: `@context`
- Priority: `A`, `B`, `C`, `D`
- Deadline: `due:YYYY-MM-DD` (e.g. `due:2022-01-15`)
- Key-Values: e.g. `key:value`
<!-- - Recurring tasks: `repeat:y/m/d` (e.g. `repeat:weekly`) -->

## Features

- Supports [todo.txt Syntax][]
- Parses and formats todo items for easy management
- Allows you to add, remove, and edit tasks in a text file
- Manage due dates and overdue tasks
- Sort todo.txt file by due-date, priority, projects or contexts
- Open todo.txt in editor
- Create a "local" todo.txt with the "-d" option

## Usage

1. Install the project using npm or yarn. 
   ```
   npm i -g todo-txt-cli
   ```

2. Add your first todo item
   ```
   todo add "my first task"
   ```

3. List your items, and display help
   ```
   todo ls
   ````

4. Display help
   ```
   todo help
   ```
   full help
   ```
   todo help help
   ```

See full options and actions in [documentation][man]

## Contributing

Contributions are welcome! If you have any issues or suggestions, please open an
issue on GitHub.

## License

This project is licensed under the [MIT License][LICENSE].

## Credits

Thanks to the Todo.txt team for their work on the original specification.

[todo.txt Syntax]: https://github.com/todotxt/todo.txt
[man]: https://gitlab.com/commenthol/todo-txt-cli/-/blob/main/man/todo-txt-cli.md

[LICENSE]: ./LICENSE
[npm-badge]: https://badgen.net/npm/v/todo-txt-cli?color=green
[npm]: https://www.npmjs.com/package/todo-txt-cli
[types-badge]: https://badgen.net/npm/types/todo-txt-cli