/notable-cli

Primary LanguageTypeScript

notable-cli

A Notable command line client

oclif Version Downloads/week License

Screenshot of search feature

Usage

$ npm install -g notable-cli
$ notable-cli COMMAND
running command...
$ notable-cli (-v|--version|version)
notable-cli/0.0.0 linux-x64 node-v12.18.2
$ notable-cli --help [COMMAND]
USAGE
  $ notable-cli COMMAND
...

Commands

notable-cli hello [FILE]

describe the command here

USAGE
  $ notable-cli hello [FILE]

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

EXAMPLE
  $ notable-cli hello
  hello world from ./src/hello.ts!

See code: src/commands/hello.ts

notable-cli help [COMMAND]

display help for notable-cli

USAGE
  $ notable-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

notable-cli search

describe the command here

USAGE
  $ notable-cli search

OPTIONS
  -c, --content=content
  -h, --help             show CLI help
  -t, --tags=tags        Tags to search

EXAMPLE
  $ notable-cli search -t nodejs -c Cheatsheet
  /home/alexandre/Documents/@plaintext/notes/Javascript - Cheatsheet.md

See code: src/commands/search.ts

notable-cli settings

Set settings of notable-cli

USAGE
  $ notable-cli settings

OPTIONS
  -h, --help       show CLI help
  -p, --path=path  Set path of Notables notes

EXAMPLE
  $ notable-cli settings --path ~/Notable/notes

See code: src/commands/settings.ts