Skip to content

Latest commit

 

History

History
127 lines (95 loc) · 3.81 KB

README.md

File metadata and controls

127 lines (95 loc) · 3.81 KB
Raw

picobrew-cli

Command line interface (CLI) used to communicate to Picobrew

oclif Version Downloads/week License

Usage

$ npm install -g picobrew-cli
$ picobrew COMMAND
running command...
$ picobrew (-v|--version|version)
picobrew-cli/0.3.0 darwin-x64 node-v12.6.0
$ picobrew --help [COMMAND]
USAGE
  $ picobrew COMMAND
...

Commands

picobrew hello [FILE]

describe the command here

USAGE
  $ picobrew hello [FILE]

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

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

See code: src/commands/hello.ts

picobrew help [COMMAND]

display help for picobrew

USAGE
  $ picobrew help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

picobrew recipes [RECIPEID]

Command used to export different formats of beer recipes from the Picobrew Brewhouse.

USAGE
  $ picobrew recipes [RECIPEID]

OPTIONS
  -a, --all                              export all recipes
  -f, --format=beerxml|json              [default: beerxml] format of recipe output
  -h, --help                             show CLI help
  -o, --output_filename=output_filename  custom output filename (default is to use name of brew recipe)
  -v, --verbose                          enable debugging output
  --output_folder=output_folder          [default: recipes] path to output folder (useful for use with `--all`)

EXAMPLES
  $ picobrew recipes <recipeId> --format=beerxml
  $ picobrew recipes --format=beerxml --output_folder=recipes/xml --all
  $ picobrew recipes --format=json --output_folder=recipes/json --all

See code: src/commands/recipes.ts

picobrew sessions [MACHINEGUID]

Command used to export sessions from linked machines from the Picobrew Brewhouse.

USAGE
  $ picobrew sessions [MACHINEGUID]

OPTIONS
  -f, --format=csv|json              [default: csv] path to output folder as each session is a separate json (with --all
                                     defaults to guid of machine)

  -h, --help                         show CLI help

  -n, --number=number                [default: 20] number of recent sessions to export

  -o, --output_folder=output_folder  [default: sessions] path to output folder as each session is a separate json (with
                                     --all defaults to guid of machine)

  -s, --session=session              identifier of a specific sessions to export (ie. 60208)

  -v, --verbose                      enable debugging output

EXAMPLES
  $ picobrew sessions <machineId> --output_folder=sessions/<machineId>
  $ picobrew sessions --number=100
  $ picobrew sessions --session=12345

See code: src/commands/sessions.ts