snowboard
API blueprint toolkit
Last updated 13 days ago by subosito .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install snowboard 
SYNC missed versions from official npm registry.

snowboard

npm version

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

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

Current Tags

  • 4.1.13                                ...           latest (13 days ago)

87 Versions

  • 4.1.13                                ...           13 days ago
  • 4.1.12                                ...           14 days ago
  • 4.1.11                                ...           a month ago
  • 4.1.10                                ...           a month ago
  • 4.1.9                                ...           a month ago
  • 4.1.8                                ...           a month ago
  • 4.1.7                                ...           a month ago
  • 4.1.6                                ...           a month ago
  • 4.1.5                                ...           a month ago
  • 4.1.4                                ...           a month ago
  • 4.1.3                                ...           a month ago
  • 4.1.2                                ...           a month ago
  • 4.1.1                                ...           a month ago
  • 4.1.0                                ...           2 months ago
  • 4.0.4                                ...           2 months ago
  • 4.0.3                                ...           2 months ago
  • 4.0.2                                ...           2 months ago
  • 4.0.1                                ...           2 months ago
  • 3.7.5                                ...           3 months ago
  • 3.7.4                                ...           3 months ago
  • 3.7.3                                ...           3 months ago
  • 3.7.2                                ...           3 months ago
  • 3.7.1                                ...           3 months ago
  • 3.7.0                                ...           3 months ago
  • 4.0.0-rc.14                                ...           3 months ago
  • 4.0.0-rc.13                                ...           3 months ago
  • 4.0.0-rc.12                                ...           3 months ago
  • 4.0.0-rc.11                                ...           3 months ago
  • 4.0.0-rc.10                                ...           3 months ago
  • 4.0.0-rc.9                                ...           3 months ago
  • 4.0.0-rc.6                                ...           3 months ago
  • 3.6.0                                ...           4 months ago
  • 3.5.7                                ...           5 months ago
  • 3.5.6                                ...           6 months ago
  • 3.5.5                                ...           6 months ago
  • 3.5.4                                ...           6 months ago
  • 3.5.4-rc1                                ...           6 months ago
  • 3.5.2                                ...           7 months ago
  • 3.5.1                                ...           7 months ago
  • 3.5.0                                ...           7 months ago
  • 3.4.1                                ...           8 months ago
  • 3.4.0                                ...           8 months ago
  • 3.3.2                                ...           9 months ago
  • 3.3.1                                ...           9 months ago
  • 3.3.0                                ...           9 months ago
  • 3.2.5                                ...           9 months ago
  • 3.2.4                                ...           9 months ago
  • 3.2.3                                ...           9 months ago
  • 3.2.2                                ...           9 months ago
  • 3.2.1                                ...           9 months ago
  • 3.2.0                                ...           9 months ago
  • 3.1.9                                ...           9 months ago
  • 3.1.8                                ...           9 months ago
  • 3.1.7                                ...           10 months ago
  • 3.1.6                                ...           10 months ago
  • 3.1.5                                ...           10 months ago
  • 3.1.4                                ...           10 months ago
  • 3.1.3                                ...           10 months ago
  • 3.1.2                                ...           10 months ago
  • 3.1.1                                ...           10 months ago
  • 3.1.0                                ...           10 months ago
  • 3.0.8                                ...           10 months ago
  • 3.0.7                                ...           10 months ago
  • 3.0.6                                ...           10 months ago
  • 3.0.5                                ...           10 months ago
  • 3.0.4                                ...           10 months ago
  • 3.0.3                                ...           10 months ago
  • 3.0.2                                ...           10 months ago
  • 3.0.0-rc.5                                ...           10 months ago
  • 3.0.0-rc.4                                ...           10 months ago
  • 3.0.0-rc.3                                ...           10 months ago
  • 3.0.0-rc.2                                ...           10 months ago
  • 3.0.0-rc.1                                ...           10 months ago
  • 2.0.6                                ...           a year ago
  • 2.0.5                                ...           a year ago
  • 2.0.4                                ...           a year ago
  • 2.0.3                                ...           a year ago
  • 2.0.2                                ...           a year ago
  • 2.0.1                                ...           a year ago
  • 2.0.0                                ...           a year ago
  • 1.8.15 [deprecated]           ...           a year ago
  • 1.8.14 [deprecated]           ...           a year ago
  • 1.8.13 [deprecated]           ...           a year ago
  • 1.8.12 [deprecated]           ...           a year ago
  • 1.8.11 [deprecated]           ...           a year ago
  • 1.8.10 [deprecated]           ...           a year ago
  • 1.8.9 [deprecated]           ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 35
Last Day 0
Last Week 1
Last Month 227
Dependencies (20)
Dev Dependencies (1)
Dependents (1)

Copyright 2014 - 2017 © taobao.org |