todoclif

A CLI to tracking your list of pending and no procrastinate anymore

• Usage
• Commands
• Contributing

Usage

$ npm install -g todoclif

$ todo COMMAND
running command...

$ todo --help [COMMAND]

USAGE
$ todo COMMAND
...

Commands

• todoclif
• Usage
• Commands
  • 📝 todo add <ITEM>
  • 🧹 todo clean <LIST_TYPE> <INDEX>
  • ✅ todo done (<INDEX> | all)
  • ✍️ todo edit <ID> "<DESC>"
  • 🏷 todo list (todo|done)
  • 🆘 todo help [COMMAND]
• Contributing

📝 todo add <ITEM>

Add an item to complete in your todo list

USAGE
  $ todo add <ITEM>

ARGUMENTS
  ITEM  Item description

DESCRIPTION
  ...
  Example: todo add "Buy some ☕️ after work"

ALIASES
  $ todo a

See code: src/commands/add.js

🧹 todo clean <LIST_TYPE> <INDEX>

Clean items list

USAGE
  $ todo clean <LIST_TYPE> <INDEX>

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

✅ todo done (<INDEX> | all)

Mark as done a pending item

USAGE
  $ todo done (<INDEX> | 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

✍️ todo edit <ID> "<DESC>"

Edit a todo item destription

USAGE
  $ todo edit <ID> "<DESC>"

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

🏷 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

🆘 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

Contributing

Do you want to contribute? Welcome! Here is the guideline.