snowboard v4.1.22

snowboard

API blueprint toolkit.

Usage

$ npm install -g snowboard
$ snowboard COMMAND
running command...
$ snowboard (-v|--version|version)
snowboard/4.0.0-rc.14 darwin-x64 node-v12.16.0
$ snowboard --help [COMMAND]
USAGE
  $ snowboard COMMAND
...

Commands

• snowboard apib INPUT
• snowboard help [COMMAND]
• snowboard html INPUT
• snowboard http INPUT
• snowboard json INPUT
• snowboard lint INPUT
• snowboard list INPUT [INPUTS...]
• snowboard mock INPUT [INPUTS...]

snowboard apib INPUT

render API blueprint

USAGE
  $ snowboard apib INPUT

OPTIONS
  -o, --output=output  output file
  -q, --quiet          quiet mode

See code: lib/commands/apib.js

snowboard help [COMMAND]

display help for snowboard

USAGE
  $ snowboard help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

snowboard html INPUT

render HTML documentation

USAGE
  $ snowboard html INPUT

OPTIONS
  -O, --optimized          optimized mode
  -o, --output=output      output directory
  -q, --quiet              quiet mode
  -t, --template=template  custom template
  -w, --watch              watch for the files changes

See code: lib/commands/html.js

snowboard http INPUT

serve HTML documentation

USAGE
  $ snowboard http INPUT

OPTIONS
  -C, --cert=cert          SSL cert file
  -K, --key=key            SSL key file
  -O, --optimized          optimized mode
  -S, --ssl                enable https
  -b, --bind=bind          [default: :8088] listen address
  -q, --quiet              quiet mode
  -t, --template=template  custom template
  -w, --watch              watch for the files changes

See code: lib/commands/http.js

snowboard json INPUT

render API elements json

USAGE
  $ snowboard json INPUT

OPTIONS
  -O, --optimized      optimized mode
  -o, --output=output  output file
  -q, --quiet          quiet mode

See code: lib/commands/json.js

snowboard lint INPUT

validate API blueprint

USAGE
  $ snowboard lint INPUT

OPTIONS
  -O, --optimized  optimized mode
  -j, --json       json mode
  -q, --quiet      quiet mode

See code: lib/commands/lint.js

snowboard list INPUT [INPUTS...]

list API routes

USAGE
  $ snowboard list INPUT [INPUTS...]

OPTIONS
  -O, --optimized  optimized mode
  -j, --json       json mode
  -q, --quiet      quiet mode

See code: lib/commands/list.js

snowboard mock INPUT [INPUTS...]

run mock server

USAGE
  $ snowboard mock INPUT [INPUTS...]

OPTIONS
  -C, --cert=cert  SSL cert file
  -K, --key=key    SSL key file
  -S, --ssl        enable https
  -b, --bind=bind  [default: :8087] listen address
  -q, --quiet      quiet mode

See code: lib/commands/mock.js