status-board-cli

CLI utility for Status Board

• Usage
• Commands

Usage

$ npm install -g status-board-cli
$ status-board COMMAND
running command...
$ status-board (-v|--version|version)
status-board-cli/2.0.52 linux-x64 node-v8.16.1
$ status-board --help [COMMAND]
USAGE
  $ status-board COMMAND
...

Commands

• status-board generate COMPONENT NAME
• status-board help [COMMAND]
• status-board install
• status-board list
• status-board new [APP] [ENV]
• status-board start [PORT]

status-board generate COMPONENT NAME

generates a basic component of type widget, dashboard or job

USAGE
  $ status-board generate COMPONENT NAME

ARGUMENTS
  COMPONENT  (widget|dashboard|job) type of component
  NAME       name of component

OPTIONS
  -h, --help  show CLI help

See code: src/commands/generate.ts

status-board help [COMMAND]

display help for status-board

USAGE
  $ status-board help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

status-board install

install package dependencies

USAGE
  $ status-board install

OPTIONS
  -h, --help  show CLI help

See code: src/commands/install.ts

status-board list

lists all available components (widgets or jobs) among all packages

USAGE
  $ status-board list

See code: src/commands/list.ts

status-board new [APP] [ENV]

generates a new dashboard project

USAGE
  $ status-board new [APP] [ENV]

ARGUMENTS
  APP  App to deploy
  ENV  Environment to deploy on

OPTIONS
  -h, --help  show CLI help

See code: src/commands/new.ts

status-board start [PORT]

starts Status Board's server

USAGE
  $ status-board start [PORT]

ARGUMENTS
  PORT  runs Status Board in port

OPTIONS
  -d, --dashboard=dashboard  loads only dashboards matching
  -j, --job=job              runs only jobs matching 'myjob'
  -n, --noinstall            skips npm package install (faster startup)

See code: src/commands/start.ts