@@ -6,9 +6,10 @@ Functions plugin for the SF CLI
6
6
[ ![ NPM] ( https://img.shields.io/npm/v/@salesforce/plugin-functions.svg?label=@salesforce/functions )] ( https://www.npmjs.com/package/@salesforce/functions ) [ ![ CircleCI] ( https://circleci.com/gh/salesforcecli/plugin-functions/tree/main.svg?style=shield )] ( https://circleci.com/gh/salesforcecli/plugin-functions/tree/main ) [ ![ Downloads/week] ( https://img.shields.io/npm/dw/@salesforce/plugin-functions.svg )] ( https://npmjs.org/package/@salesforce/plugin-functions ) [ ![ License] ( https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg )] ( https://raw.githubusercontent.com/salesforcecli/plugin-functions/main/LICENSE.txt )
7
7
8
8
<!-- toc -->
9
- * [ plugin-functions] ( #plugin-functions )
10
- * [ Usage] ( #usage )
11
- * [ Commands] ( #commands )
9
+
10
+ - [ plugin-functions] ( #plugin-functions )
11
+ - [ Usage] ( #usage )
12
+ - [ Commands] ( #commands )
12
13
<!-- tocstop -->
13
14
14
15
# Usage
@@ -26,24 +27,25 @@ Now you should be able to run functions commands, e.g. `sfdx env:list`, `sfdx lo
26
27
# Commands
27
28
28
29
<!-- commands -->
29
- * [ ` sf env:create:compute ` ] ( #sf-envcreatecompute )
30
- * [ ` sf env:delete ` ] ( #sf-envdelete )
31
- * [ ` sf env:display ` ] ( #sf-envdisplay )
32
- * [ ` sf env:list ` ] ( #sf-envlist )
33
- * [ ` sf env:log:tail ` ] ( #sf-envlogtail )
34
- * [ ` sf env:logdrain:add ` ] ( #sf-envlogdrainadd )
35
- * [ ` sf env:logdrain:list ` ] ( #sf-envlogdrainlist )
36
- * [ ` sf env:logdrain:remove ` ] ( #sf-envlogdrainremove )
37
- * [ ` sf env:var:get KEY ` ] ( #sf-envvarget-key )
38
- * [ ` sf env:var:list ` ] ( #sf-envvarlist )
39
- * [ ` sf env:var:set ` ] ( #sf-envvarset )
40
- * [ ` sf env:var:unset ` ] ( #sf-envvarunset )
41
- * [ ` sf generate:function ` ] ( #sf-generatefunction )
42
- * [ ` sf generate:project ` ] ( #sf-generateproject )
43
- * [ ` sf login:functions ` ] ( #sf-loginfunctions )
44
- * [ ` sf project:deploy:functions ` ] ( #sf-projectdeployfunctions )
45
- * [ ` sf run:function ` ] ( #sf-runfunction )
46
- * [ ` sf run:function:start ` ] ( #sf-runfunctionstart )
30
+
31
+ - [ ` sf env:create:compute ` ] ( #sf-envcreatecompute )
32
+ - [ ` sf env:delete ` ] ( #sf-envdelete )
33
+ - [ ` sf env:display ` ] ( #sf-envdisplay )
34
+ - [ ` sf env:list ` ] ( #sf-envlist )
35
+ - [ ` sf env:log:tail ` ] ( #sf-envlogtail )
36
+ - [ ` sf env:logdrain:add ` ] ( #sf-envlogdrainadd )
37
+ - [ ` sf env:logdrain:list ` ] ( #sf-envlogdrainlist )
38
+ - [ ` sf env:logdrain:remove ` ] ( #sf-envlogdrainremove )
39
+ - [ ` sf env:var:get KEY ` ] ( #sf-envvarget-key )
40
+ - [ ` sf env:var:list ` ] ( #sf-envvarlist )
41
+ - [ ` sf env:var:set ` ] ( #sf-envvarset )
42
+ - [ ` sf env:var:unset ` ] ( #sf-envvarunset )
43
+ - [ ` sf generate:function ` ] ( #sf-generatefunction )
44
+ - [ ` sf generate:project ` ] ( #sf-generateproject )
45
+ - [ ` sf login:functions ` ] ( #sf-loginfunctions )
46
+ - [ ` sf project:deploy:functions ` ] ( #sf-projectdeployfunctions )
47
+ - [ ` sf run:function ` ] ( #sf-runfunction )
48
+ - [ ` sf run:function:start ` ] ( #sf-runfunctionstart )
47
49
48
50
## ` sf env:create:compute `
49
51
@@ -56,14 +58,15 @@ USAGE
56
58
OPTIONS
57
59
-a, --setalias=setalias alias for the created environment
58
60
-o, --connected-org=connected-org username or alias for the org that the compute environment should be connected to
61
+ --json format output as json
59
62
60
63
EXAMPLES
61
64
$ sfdx env:create:compute
62
65
$ sfdx env:create:compute --setalias my-compute-environment
63
66
$ sfdx env:create:compute --connected-org my-scratch-org
64
67
```
65
68
66
- _ See code: [ src/commands/env/create/compute.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/create/compute.ts ) _
69
+ _ See code: [ src/commands/env/create/compute.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/create/compute.ts ) _
67
70
68
71
## ` sf env:delete `
69
72
@@ -76,13 +79,14 @@ USAGE
76
79
OPTIONS
77
80
-c, --confirm=name confirmation name
78
81
-e, --environment=environment (required) environment name
82
+ --json format output as json
79
83
80
84
EXAMPLES
81
85
$ sfdx env:delete --environment=billingApp-Scratch1
82
86
$ sfdx env:delete --environment=billingApp-Scratch1 --confirm=billingApp-Scratch1
83
87
```
84
88
85
- _ See code: [ src/commands/env/delete.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/delete.ts ) _
89
+ _ See code: [ src/commands/env/delete.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/delete.ts ) _
86
90
87
91
## ` sf env:display `
88
92
@@ -94,13 +98,14 @@ USAGE
94
98
95
99
OPTIONS
96
100
-e, --environment=environment (required) environment name
101
+ --json format output as json
97
102
--verbose verbose display output
98
103
99
104
EXAMPLE
100
105
$ sfdx env:display --environment=billingApp-Scratch1
101
106
```
102
107
103
- _ See code: [ src/commands/env/display.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/display.ts ) _
108
+ _ See code: [ src/commands/env/display.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/display.ts ) _
104
109
105
110
## ` sf env:list `
106
111
@@ -123,7 +128,7 @@ EXAMPLES
123
128
$ sfdx env:list --environment-type org --environment-type compute
124
129
```
125
130
126
- _ See code: [ src/commands/env/list.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/list.ts ) _
131
+ _ See code: [ src/commands/env/list.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/list.ts ) _
127
132
128
133
## ` sf env:log:tail `
129
134
@@ -135,12 +140,13 @@ USAGE
135
140
136
141
OPTIONS
137
142
-e, --environment=environment (required) environment name to retrieve logs
143
+ --json format output as json
138
144
139
145
EXAMPLE
140
146
sfdx env:log:tail --environment=billingApp-Scratch1
141
147
```
142
148
143
- _ See code: [ src/commands/env/log/tail.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/log/tail.ts ) _
149
+ _ See code: [ src/commands/env/log/tail.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/log/tail.ts ) _
144
150
145
151
## ` sf env:logdrain:add `
146
152
@@ -153,12 +159,13 @@ USAGE
153
159
OPTIONS
154
160
-e, --environment=environment (required) environment name
155
161
-u, --url=url (required) endpoint that will receive sent logs
162
+ --json format output as json
156
163
157
164
EXAMPLE
158
165
$ sfdx env:logdrain:add --environment=billingApp-Sandbox --url=https://example.com/drain
159
166
```
160
167
161
- _ See code: [ src/commands/env/logdrain/add.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/logdrain/add.ts ) _
168
+ _ See code: [ src/commands/env/logdrain/add.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/logdrain/add.ts ) _
162
169
163
170
## ` sf env:logdrain:list `
164
171
@@ -176,7 +183,7 @@ EXAMPLE
176
183
$ sfdx env:logdrain:list --environment=billingApp-Sandbox
177
184
```
178
185
179
- _ See code: [ src/commands/env/logdrain/list.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/logdrain/list.ts ) _
186
+ _ See code: [ src/commands/env/logdrain/list.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/logdrain/list.ts ) _
180
187
181
188
## ` sf env:logdrain:remove `
182
189
@@ -189,12 +196,13 @@ USAGE
189
196
OPTIONS
190
197
-e, --environment=environment (required) environment name
191
198
-u, --url=url (required) logdrain url to remove
199
+ --json format output as json
192
200
193
201
EXAMPLE
194
202
$ sfdx env:logdrain:remove --environment=billingApp-Sandbox --url=syslog://syslog-a.logdna.com:11137
195
203
```
196
204
197
- _ See code: [ src/commands/env/logdrain/remove.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/logdrain/remove.ts ) _
205
+ _ See code: [ src/commands/env/logdrain/remove.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/logdrain/remove.ts ) _
198
206
199
207
## ` sf env:var:get KEY `
200
208
@@ -206,12 +214,13 @@ USAGE
206
214
207
215
OPTIONS
208
216
-e, --environment=environment (required) environment name
217
+ --json format output as json
209
218
210
219
EXAMPLE
211
220
$ sfdx env:var:get foo --environment=my-environment
212
221
```
213
222
214
- _ See code: [ src/commands/env/var/get.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/var/get.ts ) _
223
+ _ See code: [ src/commands/env/var/get.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/var/get.ts ) _
215
224
216
225
## ` sf env:var:list `
217
226
@@ -223,12 +232,13 @@ USAGE
223
232
224
233
OPTIONS
225
234
-e, --environment=environment (required) environment name
235
+ --json format output as json
226
236
227
237
EXAMPLE
228
238
$ sfdx env:var:list --environment=my-environment
229
239
```
230
240
231
- _ See code: [ src/commands/env/var/list.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/var/list.ts ) _
241
+ _ See code: [ src/commands/env/var/list.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/var/list.ts ) _
232
242
233
243
## ` sf env:var:set `
234
244
@@ -240,12 +250,13 @@ USAGE
240
250
241
251
OPTIONS
242
252
-e, --environment=environment (required) environment name
253
+ --json format output as json
243
254
244
255
EXAMPLE
245
256
$ sfdx env:var:set foo=bar --environment=my-environment
246
257
```
247
258
248
- _ See code: [ src/commands/env/var/set.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/var/set.ts ) _
259
+ _ See code: [ src/commands/env/var/set.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/var/set.ts ) _
249
260
250
261
## ` sf env:var:unset `
251
262
@@ -257,12 +268,13 @@ USAGE
257
268
258
269
OPTIONS
259
270
-e, --environment=environment (required) environment name
271
+ --json format output as json
260
272
261
273
EXAMPLE
262
274
$ sfdx env:var:unset foo --environment=my-environment
263
275
```
264
276
265
- _ See code: [ src/commands/env/var/unset.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/env/var/unset.ts ) _
277
+ _ See code: [ src/commands/env/var/unset.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/env/var/unset.ts ) _
266
278
267
279
## ` sf generate:function `
268
280
@@ -275,6 +287,7 @@ USAGE
275
287
OPTIONS
276
288
-l, --language=(javascript|typescript|java) (required) language
277
289
-n, --name=name (required) function name
290
+ --json format output as json
278
291
279
292
ALIASES
280
293
$ sf evergreen:function:init
@@ -283,7 +296,7 @@ EXAMPLE
283
296
$ sfdx evergreen:function:create MyFunction --language=javascript
284
297
```
285
298
286
- _ See code: [ src/commands/generate/function.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/generate/function.ts ) _
299
+ _ See code: [ src/commands/generate/function.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/generate/function.ts ) _
287
300
288
301
## ` sf generate:project `
289
302
@@ -293,9 +306,10 @@ USAGE
293
306
294
307
OPTIONS
295
308
-n, --name=name (required) name of the generated project
309
+ --json format output as json
296
310
```
297
311
298
- _ See code: [ src/commands/generate/project.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/generate/project.ts ) _
312
+ _ See code: [ src/commands/generate/project.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/generate/project.ts ) _
299
313
300
314
## ` sf login:functions `
301
315
@@ -309,7 +323,7 @@ EXAMPLE
309
323
$ sfdx login:functions
310
324
```
311
325
312
- _ See code: [ src/commands/login/functions.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/login/functions.ts ) _
326
+ _ See code: [ src/commands/login/functions.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/login/functions.ts ) _
313
327
314
328
## ` sf project:deploy:functions `
315
329
@@ -326,9 +340,11 @@ OPTIONS
326
340
-q, --quiet limit the amount of output displayed from the deploy process
327
341
328
342
--force ignore warnings and overwrite remote repository (not allowed in production)
343
+
344
+ --json format output as json
329
345
```
330
346
331
- _ See code: [ src/commands/project/deploy/functions.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/project/deploy/functions.ts ) _
347
+ _ See code: [ src/commands/project/deploy/functions.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/project/deploy/functions.ts ) _
332
348
333
349
## ` sf run:function `
334
350
@@ -344,6 +360,7 @@ OPTIONS
344
360
-o, --connected-org=connected-org username or alias for the target org; overrides default target org
345
361
-p, --payload=payload set the payload of the cloudevent. also accepts @file.txt format
346
362
-s, --structured set the cloudevent to be emitted as a structured cloudevent (json)
363
+ --json format output as json
347
364
348
365
EXAMPLE
349
366
@@ -353,7 +370,7 @@ EXAMPLE
353
370
$ sfdx run:function -l http://localhost:8080 -p '{"id": 12345}' --structured
354
371
```
355
372
356
- _ See code: [ src/commands/run/function.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4 /src/commands/run/function.ts ) _
373
+ _ See code: [ src/commands/run/function.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5 /src/commands/run/function.ts ) _
357
374
358
375
## ` sf run:function:start `
359
376
@@ -369,6 +386,7 @@ OPTIONS
369
386
-p, --port=port [default: 8080] port for running the function
370
387
-v, --verbose output additional logs
371
388
--clear-cache clear associated cache before executing.
389
+ --json format output as json
372
390
373
391
--network=network Connect and build containers to a network. This can be useful to build containers which
374
392
require a local resource.
@@ -382,5 +400,6 @@ EXAMPLE
382
400
$ sfdx run:function:start --network host --no-pull --clear-cache --debug-port 9000 --port 5000
383
401
```
384
402
385
- _ See code: [ src/commands/run/function/start.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.4/src/commands/run/function/start.ts ) _
403
+ _ See code: [ src/commands/run/function/start.ts] ( https://github.com/salesforcecli/plugin-functions/blob/v0.2.5/src/commands/run/function/start.ts ) _
404
+
386
405
<!-- commandsstop -->
0 commit comments