1 | status-board-cli
|
2 | ================
|
3 |
|
4 | CLI utility for Status Board
|
5 |
|
6 | [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
|
7 | [![Version](https://img.shields.io/npm/v/status-board-cli.svg)](https://npmjs.org/package/status-board-cli)
|
8 | [![CircleCI](https://circleci.com/gh/jameswlane/status-board-cli/tree/master.svg?style=shield)](https://circleci.com/gh/jameswlane/status-board-cli/tree/master)
|
9 | [![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/jameswlane/status-board-cli?branch=master&svg=true)](https://ci.appveyor.com/project/jameswlane/status-board-cli/branch/master)
|
10 | [![Codecov](https://codecov.io/gh/jameswlane/status-board-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/jameswlane/status-board-cli)
|
11 | [![Downloads/week](https://img.shields.io/npm/dw/status-board-cli.svg)](https://npmjs.org/package/status-board-cli)
|
12 | [![License](https://img.shields.io/npm/l/status-board-cli.svg)](https://github.com/jameswlane/status-board-cli/blob/master/package.json)
|
13 |
|
14 |
|
15 | * [Usage](#usage)
|
16 | * [Commands](#commands)
|
17 |
|
18 | # Usage
|
19 |
|
20 | ```sh-session
|
21 | $ npm install -g status-board-cli
|
22 | $ status-board COMMAND
|
23 | running command...
|
24 | $ status-board (-v|--version|version)
|
25 | status-board-cli/2.0.31 linux-x64 node-v8.15.1
|
26 | $ status-board --help [COMMAND]
|
27 | USAGE
|
28 | $ status-board COMMAND
|
29 | ...
|
30 | ```
|
31 |
|
32 | # Commands
|
33 |
|
34 | * [`status-board generate COMPONENT NAME`](#status-board-generate-component-name)
|
35 | * [`status-board help [COMMAND]`](#status-board-help-command)
|
36 | * [`status-board install`](#status-board-install)
|
37 | * [`status-board list`](#status-board-list)
|
38 | * [`status-board new [APP] [ENV]`](#status-board-new-app-env)
|
39 | * [`status-board start [PORT]`](#status-board-start-port)
|
40 |
|
41 | ## `status-board generate COMPONENT NAME`
|
42 |
|
43 | generates a basic component of type widget, dashboard or job
|
44 |
|
45 | ```
|
46 | USAGE
|
47 | $ status-board generate COMPONENT NAME
|
48 |
|
49 | ARGUMENTS
|
50 | COMPONENT (widget|dashboard|job) type of component
|
51 | NAME name of component
|
52 |
|
53 | OPTIONS
|
54 | -h, --help show CLI help
|
55 | ```
|
56 |
|
57 | _See code: [src/commands/generate.ts](https://github.com/jameswlane/status-board-cli/blob/v2.0.31/src/commands/generate.ts)_
|
58 |
|
59 | ## `status-board help [COMMAND]`
|
60 |
|
61 | display help for status-board
|
62 |
|
63 | ```
|
64 | USAGE
|
65 | $ status-board help [COMMAND]
|
66 |
|
67 | ARGUMENTS
|
68 | COMMAND command to show help for
|
69 |
|
70 | OPTIONS
|
71 | --all see all commands in CLI
|
72 | ```
|
73 |
|
74 | _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_
|
75 |
|
76 | ## `status-board install`
|
77 |
|
78 | install package dependencies
|
79 |
|
80 | ```
|
81 | USAGE
|
82 | $ status-board install
|
83 |
|
84 | OPTIONS
|
85 | -h, --help show CLI help
|
86 | ```
|
87 |
|
88 | _See code: [src/commands/install.ts](https://github.com/jameswlane/status-board-cli/blob/v2.0.31/src/commands/install.ts)_
|
89 |
|
90 | ## `status-board list`
|
91 |
|
92 | lists all available components (widgets or jobs) among all packages
|
93 |
|
94 | ```
|
95 | USAGE
|
96 | $ status-board list
|
97 | ```
|
98 |
|
99 | _See code: [src/commands/list.ts](https://github.com/jameswlane/status-board-cli/blob/v2.0.31/src/commands/list.ts)_
|
100 |
|
101 | ## `status-board new [APP] [ENV]`
|
102 |
|
103 | generates a new dashboard project
|
104 |
|
105 | ```
|
106 | USAGE
|
107 | $ status-board new [APP] [ENV]
|
108 |
|
109 | ARGUMENTS
|
110 | APP App to deploy
|
111 | ENV Environment to deploy on
|
112 |
|
113 | OPTIONS
|
114 | -h, --help show CLI help
|
115 | ```
|
116 |
|
117 | _See code: [src/commands/new.ts](https://github.com/jameswlane/status-board-cli/blob/v2.0.31/src/commands/new.ts)_
|
118 |
|
119 | ## `status-board start [PORT]`
|
120 |
|
121 | starts Status Board's server
|
122 |
|
123 | ```
|
124 | USAGE
|
125 | $ status-board start [PORT]
|
126 |
|
127 | ARGUMENTS
|
128 | PORT runs Status Board in port
|
129 |
|
130 | OPTIONS
|
131 | -d, --dashboard=dashboard loads only dashboards matching
|
132 | -j, --job=job runs only jobs matching 'myjob'
|
133 | -n, --noinstall skips npm package install (faster startup)
|
134 | ```
|
135 |
|
136 | _See code: [src/commands/start.ts](https://github.com/jameswlane/status-board-cli/blob/v2.0.31/src/commands/start.ts)_
|
137 |
|