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](#bearer-cli)
|
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.100.1-canary.53+6e0c113c darwin-x64 node-v10.15.1
|
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 encrypt ENCRYPTIONKEY MESSAGE`](#bearer-encrypt-encryptionkey-message)
|
42 | * [`bearer generate`](#bearer-generate)
|
43 | * [`bearer generate:component [NAME]`](#bearer-generatecomponent-name)
|
44 | * [`bearer generate:function [NAME]`](#bearer-generatefunction-name)
|
45 | * [`bearer help [COMMAND]`](#bearer-help-command)
|
46 | * [`bearer invoke FUNCTION_NAME`](#bearer-invoke-function-name)
|
47 | * [`bearer link INTEGRATION_IDENTIFIER`](#bearer-link-integration-identifier)
|
48 | * [`bearer login`](#bearer-login)
|
49 | * [`bearer new [INTEGRATIONNAME]`](#bearer-new-integrationname)
|
50 | * [`bearer push`](#bearer-push)
|
51 | * [`bearer start`](#bearer-start)
|
52 |
|
53 | ## `bearer autocomplete [SHELL]`
|
54 |
|
55 | display autocomplete installation instructions
|
56 |
|
57 | ```
|
58 | USAGE
|
59 | $ bearer autocomplete [SHELL]
|
60 |
|
61 | ARGUMENTS
|
62 | SHELL shell type
|
63 |
|
64 | OPTIONS
|
65 | -r, --refresh-cache Refresh cache (ignores displaying instructions)
|
66 |
|
67 | EXAMPLES
|
68 | $ bearer autocomplete
|
69 | $ bearer autocomplete bash
|
70 | $ bearer autocomplete zsh
|
71 | $ bearer autocomplete --refresh-cache
|
72 | ```
|
73 |
|
74 | _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.1.0/src/commands/autocomplete/index.ts)_
|
75 |
|
76 | ## `bearer encrypt ENCRYPTIONKEY MESSAGE`
|
77 |
|
78 | Encrypt using bearer security
|
79 |
|
80 | ```
|
81 | USAGE
|
82 | $ bearer encrypt ENCRYPTIONKEY MESSAGE
|
83 |
|
84 | OPTIONS
|
85 | -h, --help show CLI help
|
86 | --path=path
|
87 | --silent
|
88 | ```
|
89 |
|
90 | _See code: [src/commands/encrypt.ts](https://github.com/Bearer/bearer/blob/v0.100.1-canary.53+6e0c113c/src/commands/encrypt.ts)_
|
91 |
|
92 | ## `bearer generate`
|
93 |
|
94 | Generate Function or Component
|
95 |
|
96 | ```
|
97 | USAGE
|
98 | $ bearer generate
|
99 |
|
100 | OPTIONS
|
101 | -h, --help show CLI help
|
102 | --path=path
|
103 | --silent
|
104 |
|
105 | ALIASES
|
106 | $ bearer g
|
107 | ```
|
108 |
|
109 | _See code: [src/commands/generate/index.ts](https://github.com/Bearer/bearer/blob/v0.100.1-canary.53+6e0c113c/src/commands/generate/index.ts)_
|
110 |
|
111 | ## `bearer generate:component [NAME]`
|
112 |
|
113 | Generate a Bearer component
|
114 |
|
115 | ```
|
116 | USAGE
|
117 | $ bearer generate:component [NAME]
|
118 |
|
119 | OPTIONS
|
120 | -h, --help show CLI help
|
121 | -t, --type=blank|collection|root
|
122 | --path=path
|
123 | --silent
|
124 |
|
125 | ALIASES
|
126 | $ bearer g:c
|
127 | ```
|
128 |
|
129 | _See code: [src/commands/generate/component.ts](https://github.com/Bearer/bearer/blob/v0.100.1-canary.53+6e0c113c/src/commands/generate/component.ts)_
|
130 |
|
131 | ## `bearer generate:function [NAME]`
|
132 |
|
133 | Generate a Bearer Function
|
134 |
|
135 | ```
|
136 | USAGE
|
137 | $ bearer generate:function [NAME]
|
138 |
|
139 | OPTIONS
|
140 | -h, --help show CLI help
|
141 | -t, --type=fetch|save
|
142 | --path=path
|
143 | --silent
|
144 |
|
145 | ALIASES
|
146 | $ bearer g:f
|
147 | ```
|
148 |
|
149 | _See code: [src/commands/generate/function.ts](https://github.com/Bearer/bearer/blob/v0.100.1-canary.53+6e0c113c/src/commands/generate/function.ts)_
|
150 |
|
151 | ## `bearer help [COMMAND]`
|
152 |
|
153 | display help for bearer
|
154 |
|
155 | ```
|
156 | USAGE
|
157 | $ bearer help [COMMAND]
|
158 |
|
159 | ARGUMENTS
|
160 | COMMAND command to show help for
|
161 |
|
162 | OPTIONS
|
163 | --all see all commands in CLI
|
164 | ```
|
165 |
|
166 | _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.4/src/commands/help.ts)_
|
167 |
|
168 | ## `bearer invoke FUNCTION_NAME`
|
169 |
|
170 | Invoke Function locally
|
171 |
|
172 | ```
|
173 | USAGE
|
174 | $ bearer invoke FUNCTION_NAME
|
175 |
|
176 | OPTIONS
|
177 | -h, --help show CLI help
|
178 | -p, --path=path
|
179 | ```
|
180 |
|
181 | _See code: [src/commands/invoke.ts](https://github.com/Bearer/bearer/blob/v0.100.1-canary.53+6e0c113c/src/commands/invoke.ts)_
|
182 |
|
183 | ## `bearer link INTEGRATION_IDENTIFIER`
|
184 |
|
185 | Link your local integration to a remote one
|
186 |
|
187 | ```
|
188 | USAGE
|
189 | $ bearer link INTEGRATION_IDENTIFIER
|
190 |
|
191 | OPTIONS
|
192 | -h, --help show CLI help
|
193 | --path=path
|
194 | --silent
|
195 | ```
|
196 |
|
197 | _See code: [src/commands/link.ts](https://github.com/Bearer/bearer/blob/v0.100.1-canary.53+6e0c113c/src/commands/link.ts)_
|
198 |
|
199 | ## `bearer login`
|
200 |
|
201 | Login to Bearer platform
|
202 |
|
203 | ```
|
204 | USAGE
|
205 | $ bearer login
|
206 |
|
207 | OPTIONS
|
208 | -e, --email=email
|
209 | -h, --help show CLI help
|
210 | --path=path
|
211 | --silent
|
212 | ```
|
213 |
|
214 | _See code: [src/commands/login.ts](https://github.com/Bearer/bearer/blob/v0.100.1-canary.53+6e0c113c/src/commands/login.ts)_
|
215 |
|
216 | ## `bearer new [INTEGRATIONNAME]`
|
217 |
|
218 | Generate a new integration
|
219 |
|
220 | ```
|
221 | USAGE
|
222 | $ bearer new [INTEGRATIONNAME]
|
223 |
|
224 | OPTIONS
|
225 | -a, --authType=OAUTH1|OAUTH2|BASIC|APIKEY|NONE Authorization type
|
226 | -h, --help show CLI help
|
227 | --path=path
|
228 | --silent
|
229 | ```
|
230 |
|
231 | _See code: [src/commands/new.ts](https://github.com/Bearer/bearer/blob/v0.100.1-canary.53+6e0c113c/src/commands/new.ts)_
|
232 |
|
233 | ## `bearer push`
|
234 |
|
235 | Deploy Integration to Bearer Platform
|
236 |
|
237 | ```
|
238 | USAGE
|
239 | $ bearer push
|
240 |
|
241 | OPTIONS
|
242 | -h, --help show CLI help
|
243 | --path=path
|
244 | --silent
|
245 | ```
|
246 |
|
247 | _See code: [src/commands/push.ts](https://github.com/Bearer/bearer/blob/v0.100.1-canary.53+6e0c113c/src/commands/push.ts)_
|
248 |
|
249 | ## `bearer start`
|
250 |
|
251 | Start local development environment
|
252 |
|
253 | ```
|
254 | USAGE
|
255 | $ bearer start
|
256 |
|
257 | OPTIONS
|
258 | -h, --help show CLI help
|
259 | --no-install
|
260 | --no-open
|
261 | ```
|
262 |
|
263 | _See code: [src/commands/start.ts](https://github.com/Bearer/bearer/blob/v0.100.1-canary.53+6e0c113c/src/commands/start.ts)_
|
264 |
|