Skip to content

A simple note, cheatsheet taking cli with easy search

License

Notifications You must be signed in to change notification settings

crimson-med/dust-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dust-cli

A simple note, cheatsheet taking cli with easy search

oclif Version Downloads/week License

Usage

  $ yarn global add dust-cli
  $ dust init
  $ dust COMMAND
  running command...
  $ dust (-v|--version|version)
  dust-cli/0.0.0 darwin-x64 node-v12.9.1
  $ dust --help [COMMAND]
  USAGE
  $ dust COMMAND
  ...

Commands

dust init

This only needs to be ran after installation or upgrade. It will initialize all databases and local storage.

You can directly pass the auhor to not get promped by the interactive CLI.

USAGE
  $ dust init
  $ dust init [USERNAME]

EXAMPLE
  $ dust init crimson-med

dust search [TITLE]

USAGE
  $ dust search [SEARCH]

OPTIONS
  -c, --cheatsheets  search in cheatsheets only
  -g, --guides       search in guides only
  -n, --notes        search in notes only

EXAMPLE
  $ dust search "aws security"
  $ dust search mystring -n

dust add [TYPE] [TITLE] [DESCRIPTION]

Add new dust, you can select the type and title and the command / description.

USAGE
  $ dust add [TYPE] [TITLE] [DESCRIPTION]

OPTIONS
  -t, --type=cheatsheet|note|guide

EXAMPLE
  $ dust add "aws security policy" "another test" --t=note 
  $ dust add cheatsheet la "ls -a"

dust help [COMMAND]

View the help or the help for a specific command

USAGE
  $ dust help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

Dev Usage

A few commands to dev

$ ./bin/run init
$ ./bin/run add cheatsheet la "ls -a"
$ ./bin/run search la -c

About

A simple note, cheatsheet taking cli with easy search

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages