https://github.com/toti1212/todoclif
⏰ A CLI to tracking your list of pending and not procrastinate anymore
https://github.com/toti1212/todoclif
bash cli cli-app oclif organization procrastination todo todocli
Last synced: 12 months ago
JSON representation
⏰ A CLI to tracking your list of pending and not procrastinate anymore
- Host: GitHub
- URL: https://github.com/toti1212/todoclif
- Owner: toti1212
- License: mit
- Created: 2019-05-01T22:51:59.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-28T17:02:47.000Z (almost 7 years ago)
- Last Synced: 2025-05-23T17:34:35.012Z (about 1 year ago)
- Topics: bash, cli, cli-app, oclif, organization, procrastination, todo, todocli
- Language: JavaScript
- Homepage:
- Size: 320 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# todoclif
A CLI to tracking your list of pending and no procrastinate anymore
[](https://oclif.io)
[](https://npmjs.org/package/todoclif)
[](https://npmjs.org/package/todoclif)
[](https://github.com/toti1212/todoclif/blob/master/LICENSE)
[](https://github.com/toti1212/todoclif/blob/master/CONTRIBUTING.md)
- [Usage](#usage)
- [Commands](#commands)
- [Contributing](#contributing)
[](https://asciinema.org/a/1vZPqGb8ml2iZxUwSo9tFmG30)
# Usage
```shell
$ npm install -g todoclif
$ todo COMMAND
running command...
$ todo --help [COMMAND]
USAGE
$ todo COMMAND
...
```
# Commands
- [todoclif](#todoclif)
- [Usage](#usage)
- [Commands](#commands)
- [`📝 todo add `](#%f0%9f%93%9d-todo-add-item)
- [`🧹 todo clean `](#%f0%9f%a7%b9-todo-clean-listtype-index)
- [`✅ todo done ( | all)`](#%e2%9c%85-todo-done-index--all)
- [`✍️ todo edit ""`](#%e2%9c%8d%ef%b8%8f-todo-edit-id-%22desc%22)
- [`🏷 todo list (todo|done)`](#%f0%9f%8f%b7-todo-list-tododone)
- [`🆘 todo help [COMMAND]`](#%f0%9f%86%98-todo-help-command)
- [Contributing](#contributing)
## `📝 todo add `
Add an item to complete in your todo list
```
USAGE
$ todo add
ARGUMENTS
ITEM Item description
DESCRIPTION
...
Example: todo add "Buy some ☕️ after work"
ALIASES
$ todo a
```
_See code: [src/commands/add.js](https://github.com/toti1212/todoclif/blob/master/src/commands/add.js)_
## `🧹 todo clean `
Clean items list
```
USAGE
$ todo clean
OPTIONS
a, all all lists
d, done done list
t, todo todo list
DESCRIPTION
...
Example:
$ todo clean todo
$ todo clean all
$ todo clean done 1
ALIASES
$ todo cl
$ todo c
```
_See code: [src/commands/clean.js](https://github.com/toti1212/todoclif/blob/master/src/commands/clean.js)_
## `✅ todo done ( | all)`
Mark as done a pending item
```
USAGE
$ todo done ( | all)
ARGUMENTS
INDEX Todo item identifier
all Command to mark all items as done
DESCRIPTION
...
Example:
$ todo done 1
$ todo done all
ALIASES
$ todo d
```
_See code: [src/commands/done.js](https://github.com/toti1212/todoclif/blob/master/src/commands/done.js)_
## `✍️ todo edit ""`
Edit a todo item destription
```
USAGE
$ todo edit ""
ARGUMENTS
ID Item ID identifier
DESC New description
DESCRIPTION
...
Example: todo edit 1 "The new description 🙈"
ALIASES
$ todo e
```
_See code: [src/commands/done.js](https://github.com/toti1212/todoclif/blob/master/src/commands/done.js)_
## `🏷 todo list (todo|done)`
List of pending and done items
```
USAGE
$ todo list (todo|done)
ARGUMENTS
TYPE (todo|done) Items list. You can get pending or done items;
DESCRIPTION
...
Example:
$ todo list
$ todo list todo
$ todo list done
ALIASES
$ todo ls
$ todo l
```
_See code: [src/commands/list.js](https://github.com/toti1212/todoclif/blob/master/src/commands/list.js)_
## `🆘 todo help [COMMAND]`
display help for todo
```
USAGE
$ todo help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_
# Contributing
Do you want to contribute? Welcome! [Here is the guideline](https://github.com/toti1212/todoclif/blob/master/CONTRIBUTING.md).