cli-notes

A command line application for creating plain text notes

• cli-notes
• Usage
• Commands
  • notes hello [FILE]
  • notes help [COMMAND]
  • notes create [COMMAND]
• Development Instructions
  • Running the CLI in development mode

Usage

$ npm install -g cli-notes
$ notes COMMAND
running command...
$ notes (-v|--version|version)
cli-notes/0.0.0 darwin-x64 node-v14.15.5
$ notes --help [COMMAND]
USAGE
  $ notes COMMAND
...

Commands

• notes hello [FILE]
• notes help [COMMAND]
• notes create [COMMAND]

notes hello [FILE]

Describe the command here

USAGE
  $ notes hello [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

EXAMPLE
  $ notes hello
  hello world from ./src/hello.ts!

See code: src/commands/hello.ts

notes help [COMMAND]

Display help for notes

USAGE
  $ notes help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

notes create [COMMAND]

Create a new note

USAGE
  $ notes create [TYPE]

ARGUMENTS
  COMMAND  Type of note to create. Accepts "meeting", "todo", or leave blank

OPTIONS
  --project

---

Development Instructions

Running the CLI in development mode

You can run the CLI while developing, as follows:

$ ./bin/run help

This will run the help command directly, without needing to re-build and re-install the package.

---