Welcome to todo 👋

A simple CLI todo app based on https://github.com/ZeroX-DG/checkme project.

• Prerequisites
• Install
• Run tests
• Usage
• Commands
• Author

Prerequisites

• node >=8.0.0

Install

npm install

Run tests

npm run test

Usage

$ npm install -g todo
$ todo COMMAND
running command...
$ todo (-v|--version|version)
todo/0.0.0 linux-x64 node-v10.16.3
$ todo --help [COMMAND]
USAGE
  $ todo COMMAND
...

Commands

• todo add [TASK]
• todo help [COMMAND]
• todo list
• todo mark
• todo remove [INDEX]
• todo teste

todo add [TASK]

Add new task

USAGE
  $ todo add [TASK]

OPTIONS
  -d, --done  check task as done

See code: src/commands/add.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

todo list

Print out all todos

USAGE
  $ todo list

See code: src/commands/list.js

todo mark

Mark/Unmark your tasks

USAGE
  $ todo mark

See code: src/commands/mark.js

todo remove [INDEX]

Remove a todo from list

USAGE
  $ todo remove [INDEX]

EXAMPLES

  $ todo remove 0
  [Success] Removed todo: a new todo


  $ todo remove
  ›   Error: please specify the todo's index

See code: src/commands/remove.js

Author

👤 Dalton Jorge @daltonjorge

Show your support

Give a ⭐️ if this project helped you!

---

This README was generated with ❤️ by readme-md-generator