Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sahilpabale/noteli
A CLI-based Notes App built using TypeScript, MongoDB, and Auth0.
https://github.com/sahilpabale/noteli
auth0 cli good-first-issue hacktoberfest hacktoberfest2021 mongodb nodejs typescript
Last synced: 6 days ago
JSON representation
A CLI-based Notes App built using TypeScript, MongoDB, and Auth0.
- Host: GitHub
- URL: https://github.com/sahilpabale/noteli
- Owner: sahilpabale
- License: mit
- Created: 2021-08-19T12:50:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-30T23:49:45.000Z (about 1 year ago)
- Last Synced: 2024-10-31T08:52:25.690Z (13 days ago)
- Topics: auth0, cli, good-first-issue, hacktoberfest, hacktoberfest2021, mongodb, nodejs, typescript
- Language: TypeScript
- Homepage: https://noteli.tech
- Size: 1.25 MB
- Stars: 132
- Watchers: 4
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# noteli
A CLI based Notes App built using TypeScript, MongoDB and Auth0.
[](https://oclif.io)
[](https://npmjs.org/package/noteli)
[](https://npmjs.org/package/noteli)
[](https://github.com/sahilpabale/noteli/blob/master/package.json)
* [noteli](#noteli)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ 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-create)
* [`noteli delete `](#noteli-delete-id)
* [`noteli help [COMMAND]`](#noteli-help-command)
* [`noteli login`](#noteli-login)
* [`noteli logout`](#noteli-logout)
* [`noteli read`](#noteli-read)
* [`noteli update `](#noteli-update-id)
* [`noteli whoami`](#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](https://github.com/sahilpabale/noteli/blob/v1.5.4/src/commands/create.ts)_
## `noteli delete `
delete your note(s)
```
USAGE
$ noteli delete
DESCRIPTION
You can delete some specific notes if you think they are not worthy.
EXAMPLE
$ noteli delete 2
```
_See code: [src/commands/delete.ts](https://github.com/sahilpabale/noteli/blob/v1.5.4/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](https://github.com/oclif/plugin-help/blob/v3.2.3/src/commands/help.ts)_
## `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](https://github.com/sahilpabale/noteli/blob/v1.5.4/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](https://github.com/sahilpabale/noteli/blob/v1.5.4/src/commands/logout.ts)_
## `noteli read`
read all your notes
```
USAGE
$ noteli read
$ noteli read
DESCRIPTION
You can read all your notes or some specific note too.
EXAMPLES
$ noteli read
$ noteli read 2
```
_See code: [src/commands/read.ts](https://github.com/sahilpabale/noteli/blob/v1.5.4/src/commands/read.ts)_
## `noteli update `
update your note(s)
```
USAGE
$ noteli update
DESCRIPTION
You can update some specific notes if you think they need some change.
EXAMPLE
$ noteli update 2
```
_See code: [src/commands/update.ts](https://github.com/sahilpabale/noteli/blob/v1.5.4/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](https://github.com/sahilpabale/noteli/blob/v1.5.4/src/commands/whoami.ts)_