1 | # @bearer/cli
|
2 |
|
3 | Bearer CLI
|
4 |
|
5 | [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
|
6 | [![Version](https://img.shields.io/npm/v/@bearer/cli.svg)](https://npmjs.org/package/@bearer/cli)
|
7 |
|
8 | [![CircleCI](https://circleci.com/gh/Bearer/bearer/packages/cli/tree/master.svg?style=shield)](https://circleci.com/gh/Bearer/bearer/packages/cli/tree/master)
|
9 |
|
10 | [![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/Bearer/bearer/packages/cli?branch=master&svg=true)](https://ci.appveyor.com/project/Bearer/bearer/packages/cli/branch/master)
|
11 | [![Codecov](https://codecov.io/gh/Bearer/bearer/packages/cli/branch/master/graph/badge.svg)](https://codecov.io/gh/Bearer/bearer/packages/cli)
|
12 | [![Downloads/week](https://img.shields.io/npm/dw/@bearer/cli.svg)](https://npmjs.org/package/@bearer/cli)
|
13 | [![License](https://img.shields.io/npm/l/@bearer/cli.svg)](https://github.com/Bearer/bearer/packages/cli/blob/master/package.json)
|
14 |
|
15 |
|
16 | * [@bearer/cli](#bearercli)
|
17 | * [Usage](#usage)
|
18 | * [Commands](#commands)
|
19 |
|
20 |
|
21 | # Usage
|
22 |
|
23 |
|
24 | ```sh-session
|
25 | $ npm install -g @bearer/cli
|
26 | $ bearer COMMAND
|
27 | running command...
|
28 | $ bearer (-v|--version|version)
|
29 | @bearer/cli/0.111.0-canary.10+09f928ab darwin-x64 node-v10.15.3
|
30 | $ bearer --help [COMMAND]
|
31 | USAGE
|
32 | $ bearer COMMAND
|
33 | ...
|
34 | ```
|
35 |
|
36 |
|
37 | # Commands
|
38 |
|
39 |
|
40 | * [`bearer autocomplete [SHELL]`](#bearer-autocomplete-shell)
|
41 | * [`bearer generate`](#bearer-generate)
|
42 | * [`bearer generate:component [NAME]`](#bearer-generatecomponent-name)
|
43 | * [`bearer generate:function [NAME]`](#bearer-generatefunction-name)
|
44 | * [`bearer help [COMMAND]`](#bearer-help-command)
|
45 | * [`bearer integrations`](#bearer-integrations)
|
46 | * [`bearer integrations:create`](#bearer-integrationscreate)
|
47 | * [`bearer invoke FUNCTION_NAME`](#bearer-invoke-function_name)
|
48 | * [`bearer link [INTEGRATION_IDENTIFIER]`](#bearer-link-integration_identifier)
|
49 | * [`bearer login`](#bearer-login)
|
50 | * [`bearer new [INTEGRATIONNAME]`](#bearer-new-integrationname)
|
51 | * [`bearer push`](#bearer-push)
|
52 | * [`bearer setup:auth`](#bearer-setupauth)
|
53 | * [`bearer start`](#bearer-start)
|
54 |
|
55 | ## `bearer autocomplete [SHELL]`
|
56 |
|
57 | display autocomplete installation instructions
|
58 |
|
59 | ```
|
60 | USAGE
|
61 | $ bearer autocomplete [SHELL]
|
62 |
|
63 | ARGUMENTS
|
64 | SHELL shell type
|
65 |
|
66 | OPTIONS
|
67 | -r, --refresh-cache Refresh cache (ignores displaying instructions)
|
68 |
|
69 | EXAMPLES
|
70 | $ bearer autocomplete
|
71 | $ bearer autocomplete bash
|
72 | $ bearer autocomplete zsh
|
73 | $ bearer autocomplete --refresh-cache
|
74 | ```
|
75 |
|
76 | _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.1.0/src/commands/autocomplete/index.ts)_
|
77 |
|
78 | ## `bearer generate`
|
79 |
|
80 | generate Function or Component
|
81 |
|
82 | ```
|
83 | USAGE
|
84 | $ bearer generate
|
85 |
|
86 | OPTIONS
|
87 | -h, --help show CLI help
|
88 | --path=path
|
89 | --silent
|
90 |
|
91 | ALIASES
|
92 | $ bearer g
|
93 | ```
|
94 |
|
95 | _See code: [src/commands/generate/index.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/generate/index.ts)_
|
96 |
|
97 | ## `bearer generate:component [NAME]`
|
98 |
|
99 | Generate a Bearer component
|
100 |
|
101 | ```
|
102 | USAGE
|
103 | $ bearer generate:component [NAME]
|
104 |
|
105 | OPTIONS
|
106 | -h, --help show CLI help
|
107 | -t, --type=blank|collection|root
|
108 | --path=path
|
109 | --silent
|
110 |
|
111 | ALIASES
|
112 | $ bearer g:c
|
113 | ```
|
114 |
|
115 | _See code: [src/commands/generate/component.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/generate/component.ts)_
|
116 |
|
117 | ## `bearer generate:function [NAME]`
|
118 |
|
119 | Generate a Bearer Function
|
120 |
|
121 | ```
|
122 | USAGE
|
123 | $ bearer generate:function [NAME]
|
124 |
|
125 | OPTIONS
|
126 | -h, --help show CLI help
|
127 | --path=path
|
128 | --silent
|
129 |
|
130 | ALIASES
|
131 | $ bearer g:f
|
132 | ```
|
133 |
|
134 | _See code: [src/commands/generate/function.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/generate/function.ts)_
|
135 |
|
136 | ## `bearer help [COMMAND]`
|
137 |
|
138 | display help for bearer
|
139 |
|
140 | ```
|
141 | USAGE
|
142 | $ bearer help [COMMAND]
|
143 |
|
144 | ARGUMENTS
|
145 | COMMAND command to show help for
|
146 |
|
147 | OPTIONS
|
148 | --all see all commands in CLI
|
149 | ```
|
150 |
|
151 | _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_
|
152 |
|
153 | ## `bearer integrations`
|
154 |
|
155 | list deployed integrations
|
156 |
|
157 | ```
|
158 | USAGE
|
159 | $ bearer integrations
|
160 |
|
161 | OPTIONS
|
162 | -h, --help show CLI help
|
163 | --path=path
|
164 | --silent
|
165 | ```
|
166 |
|
167 | _See code: [src/commands/integrations/index.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/integrations/index.ts)_
|
168 |
|
169 | ## `bearer integrations:create`
|
170 |
|
171 | create a new Integration
|
172 |
|
173 | ```
|
174 | USAGE
|
175 | $ bearer integrations:create
|
176 |
|
177 | OPTIONS
|
178 | -d, --description=description
|
179 | -h, --help show CLI help
|
180 | -l, --skipLink
|
181 | -n, --name=name
|
182 | --path=path
|
183 | --silent
|
184 | ```
|
185 |
|
186 | _See code: [src/commands/integrations/create.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/integrations/create.ts)_
|
187 |
|
188 | ## `bearer invoke FUNCTION_NAME`
|
189 |
|
190 | invoke Function locally
|
191 |
|
192 | ```
|
193 | USAGE
|
194 | $ bearer invoke FUNCTION_NAME
|
195 |
|
196 | OPTIONS
|
197 | -h, --help show CLI help
|
198 | -p, --path=path
|
199 | ```
|
200 |
|
201 | _See code: [src/commands/invoke.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/invoke.ts)_
|
202 |
|
203 | ## `bearer link [INTEGRATION_IDENTIFIER]`
|
204 |
|
205 | link to remote Bearer Integration
|
206 |
|
207 | ```
|
208 | USAGE
|
209 | $ bearer link [INTEGRATION_IDENTIFIER]
|
210 |
|
211 | OPTIONS
|
212 | -h, --help show CLI help
|
213 | --path=path
|
214 | --silent
|
215 | ```
|
216 |
|
217 | _See code: [src/commands/link.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/link.ts)_
|
218 |
|
219 | ## `bearer login`
|
220 |
|
221 | login using Bearer credentials
|
222 |
|
223 | ```
|
224 | USAGE
|
225 | $ bearer login
|
226 |
|
227 | OPTIONS
|
228 | -h, --help show CLI help
|
229 | --path=path
|
230 | --silent
|
231 | ```
|
232 |
|
233 | _See code: [src/commands/login.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/login.ts)_
|
234 |
|
235 | ## `bearer new [INTEGRATIONNAME]`
|
236 |
|
237 | generate integration boilerplate
|
238 |
|
239 | ```
|
240 | USAGE
|
241 | $ bearer new [INTEGRATIONNAME]
|
242 |
|
243 | OPTIONS
|
244 | -a, --authType=OAUTH1|OAUTH2|BASIC|APIKEY|NONE|CUSTOM Authorization type
|
245 | -h, --help show CLI help
|
246 | --path=path
|
247 | --silent
|
248 | --withViews
|
249 | ```
|
250 |
|
251 | _See code: [src/commands/new.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/new.ts)_
|
252 |
|
253 | ## `bearer push`
|
254 |
|
255 | deploy Integration to Bearer
|
256 |
|
257 | ```
|
258 | USAGE
|
259 | $ bearer push
|
260 |
|
261 | OPTIONS
|
262 | -h, --help show CLI help
|
263 | --path=path
|
264 | --silent
|
265 | ```
|
266 |
|
267 | _See code: [src/commands/push.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/push.ts)_
|
268 |
|
269 | ## `bearer setup:auth`
|
270 |
|
271 | setup local credentials
|
272 |
|
273 | ```
|
274 | USAGE
|
275 | $ bearer setup:auth
|
276 |
|
277 | OPTIONS
|
278 | -h, --help show CLI help
|
279 | --path=path
|
280 | --silent
|
281 | ```
|
282 |
|
283 | _See code: [src/commands/setup/auth.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/setup/auth.ts)_
|
284 |
|
285 | ## `bearer start`
|
286 |
|
287 | start local development environment
|
288 |
|
289 | ```
|
290 | USAGE
|
291 | $ bearer start
|
292 |
|
293 | OPTIONS
|
294 | -f, --force Start using random available port
|
295 | -h, --help show CLI help
|
296 | --no-install
|
297 | --no-open
|
298 | ```
|
299 |
|
300 | _See code: [src/commands/start.ts](https://github.com/Bearer/bearer/blob/v0.111.0-canary.10+09f928ab/src/commands/start.ts)_
|
301 |
|