@shaharyarahmed/tdcli
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published

Todocli

A command line todo app

I decided to make the project a little bit more better, so I used the oclif npm package

There is alot of room for improvements and I will improve the project in the near future, However it is project submission worthy so I decided to submit it..

Usage

$ npm install -g @shaharyarahmed/tdcli
$ todocli COMMAND
running command...
$ todocli (-v|--version|version)
@shaharyarahmed/tdcli/0.0.1 linux-x64 node-v16.4.2
$ todocli --help [COMMAND]
USAGE
  $ todocli COMMAND
...

Commands

todocli add

Adds a new todo

USAGE
  $ todocli add

OPTIONS
  -n, --new_task=new_task  a new task

See code: src/commands/add.ts

todocli completed

Assigns todo as completed

USAGE
  $ todocli completed

OPTIONS
  -t, --todo=todo  (required) name of the todo

See code: src/commands/completed.ts

todocli delete

Removes a todo

USAGE
  $ todocli delete

OPTIONS
  -t, --todo=todo  (required) name of the todo

See code: src/commands/delete.ts

todocli help [COMMAND]

display help for todocli

USAGE
  $ todocli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

todocli print

Prints all exisiting todos

USAGE
  $ todocli print

See code: src/commands/print.ts

Example

$ ./bin/run add -n study  # Adds new todo
$ ./bin/run add -n eat    # Adds new todo
$ ./bin/run delete -t [NAME OF TODO] # Removes TODO
$ ./bin/run completed -t [NAME OF TODO] # Completes TODO
$ ./bin/run print # Prints all todos

Readme

Keywords

Package Sidebar

Install

npm i @shaharyarahmed/tdcli

Weekly Downloads

0

Version

0.0.1

License

MIT

Unpacked Size

10.9 kB

Total Files

19

Last publish

Collaborators

  • shaharyarahmed