imsaptarshi/noteli

A CLI-based Notes App built using TypeScript, MongoDB, and Auth0.

noteli

A CLI based Notes App built using TypeScript, MongoDB and Auth0.

• noteli
• Usage
• Commands

Usage

$ npm install -g noteli
$ noteli COMMAND
running command...
$ noteli (-v|--version|version)
noteli/1.5.4 win32-x64 node-v14.16.1
$ noteli --help [COMMAND]
USAGE
  $ noteli COMMAND
...

Commands

• noteli create
• noteli delete <ID>
• noteli help [COMMAND]
• noteli login
• noteli logout
• noteli read
• noteli update <ID>
• noteli whoami

noteli create

create a new note

USAGE
  $ noteli create

DESCRIPTION
  Helps you create a fresh new Note :)

See code: src/commands/create.ts

noteli delete <ID>

delete your note(s)

USAGE
  $ noteli delete <ID>

DESCRIPTION
  You can delete some specific notes if you think they are not worthy.

EXAMPLE
  $ noteli delete 2

See code: src/commands/delete.ts

noteli help [COMMAND]

display help for noteli

USAGE
  $ noteli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

noteli login

login the user for noteli

USAGE
  $ noteli login

DESCRIPTION
  Uses Auth0 Social Login to authorize user using browser.

See code: src/commands/login.ts

noteli logout

logout the user from noteli

USAGE
  $ noteli logout

DESCRIPTION
  Revokes the token and logs out user from system.

See code: src/commands/logout.ts

noteli read

read all your notes

USAGE
  $ noteli read
  $ noteli read <ID>

DESCRIPTION
  You can read all your notes or some specific note too.

EXAMPLES
  $ noteli read
  $ noteli read 2

See code: src/commands/read.ts

noteli update <ID>

update your note(s)

USAGE
  $ noteli update <ID>

DESCRIPTION
  You can update some specific notes if you think they need some change.

EXAMPLE
  $ noteli update 2

See code: src/commands/update.ts

noteli whoami

shows the current logged-in user

USAGE
  $ noteli whoami

DESCRIPTION
  Checks for the token and verifies with Auth0 for authencticity.

See code: src/commands/whoami.ts