@@ -75,7 +75,6 @@ sfdx plugins
75
75
# Usage
76
76
77
77
<!-- usage -->
78
-
79
78
``` sh-session
80
79
$ npm install -g @salesforce/plugin-source
81
80
$ sfdx COMMAND
@@ -87,18 +86,17 @@ USAGE
87
86
$ sfdx COMMAND
88
87
...
89
88
```
90
-
91
89
<!-- usagestop -->
92
90
93
91
# Commands
94
92
95
93
<!-- commands -->
96
-
97
- - [ ` sfdx force:source:convert [-r <directory >] [-d <directory>] [-n <string>] [-p <array> | -x <string > | -m <array>] [-- json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourceconvert--r-directory--d-directory--n-string-- p-array---x-string---m- array---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
98
- - [ ` sfdx force:source:deploy [--soapdeploy] [- w <minutes>] [-q <id> | -x <filepath> | -m <array> | -p <array> | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g ] [-u <string>] [--apiversion <string>] [--verbose] [-- json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourcedeploy---soapdeploy-- w-minutes--q -id---x-filepath---m-array---p-array---c---l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg---r-array---o---g-- u-string---apiversion-string---verbose ---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
99
- - [ ` sfdx force:source:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourcedeploycancel --w-minutes--i-id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
100
- - [ ` sfdx force:source:deploy:report [-w <minutes>] [-i <id> ] [-u <string>] [--apiversion <string>] [--verbose] [-- json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourcedeployreport--w-minutes--i-id-- u-string---apiversion-string---verbose ---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
101
- - [ ` sfdx force:source:retrieve [-p <array> | -x <filepath> | -m <array>] [-w <minutes>] [-n <array>] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourceretrieve--p-array---x-filepath---m-array--w-minutes--n-array--u-string--a-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
94
+ * [ ` sfdx force:source:convert [-r <directory>] [-d <directory>] [-n <string>] [-p <array> | -x <string> | -m <array>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourceconvert--r-directory--d-directory--n-string--p-array---x-string---m-array---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
95
+ * [ ` sfdx force:source:deploy [--soapdeploy] [-w <minutes >] [-q <id> | -x <filepath> | -m <array> | -p <array > | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g ] [-u <string>] [--apiversion <string>] [--verbose] [-- json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourcedeploy---soapdeploy--w-minutes--q-id---x-filepath---m-array--- p-array---c---l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg---r- array---o---g--u-string---apiversion-string---verbose ---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
96
+ * [ ` sfdx force:source:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourcedeploycancel-- w-minutes--i -id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
97
+ * [ ` sfdx force:source:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [-- json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourcedeployreport --w-minutes--i-id--u-string---apiversion-string---verbose ---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
98
+ * [ ` sfdx force:source:open -f <filepath> [-r ] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourceopen--f-filepath--r-- u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
99
+ * [ ` sfdx force:source:retrieve [-p <array> | -x <filepath> | -m <array>] [-w <minutes>] [-n <array>] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forcesourceretrieve--p-array---x-filepath---m-array--w-minutes--n-array--u-string--a-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
102
100
103
101
## ` sfdx force:source:convert [-r <directory>] [-d <directory>] [-n <string>] [-p <array> | -x <string> | -m <array>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
104
102
@@ -108,7 +106,7 @@ convert source into Metadata API format
108
106
convert source into Metadata API format
109
107
110
108
USAGE
111
- $ sfdx force:source:convert [-r <directory>] [-d <directory>] [-n <string>] [-p <array> | -x <string> | -m <array>]
109
+ $ sfdx force:source:convert [-r <directory>] [-d <directory>] [-n <string>] [-p <array> | -x <string> | -m <array>]
112
110
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
113
111
114
112
OPTIONS
@@ -151,8 +149,8 @@ deploy source to an org
151
149
deploy source to an org
152
150
153
151
USAGE
154
- $ sfdx force:source:deploy [--soapdeploy] [-w <minutes>] [-q <id> | -x <filepath> | -m <array> | -p <array> | -c | -l
155
- NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g] [-u <string>] [--apiversion
152
+ $ sfdx force:source:deploy [--soapdeploy] [-w <minutes>] [-q <id> | -x <filepath> | -m <array> | -p <array> | -c | -l
153
+ NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g] [-u <string>] [--apiversion
156
154
<string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
157
155
158
156
OPTIONS
@@ -226,7 +224,7 @@ cancel a source deployment
226
224
cancel a source deployment
227
225
228
226
USAGE
229
- $ sfdx force:source:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
227
+ $ sfdx force:source:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
230
228
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
231
229
232
230
OPTIONS
@@ -264,7 +262,7 @@ check the status of a metadata deployment
264
262
check the status of a metadata deployment
265
263
266
264
USAGE
267
- $ sfdx force:source:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--json]
265
+ $ sfdx force:source:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--json]
268
266
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
269
267
270
268
OPTIONS
@@ -301,6 +299,48 @@ EXAMPLES
301
299
302
300
_ See code: [ src/commands/force/source/deploy/report.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.0.5/src/commands/force/source/deploy/report.ts ) _
303
301
302
+ ## ` sfdx force:source:open -f <filepath> [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
303
+
304
+ edit a Lightning Page with Lightning App Builder
305
+
306
+ ```
307
+ edit a Lightning Page with Lightning App Builder
308
+ Opens the specified Lightning Page in Lightning App Builder. Lightning Page files have the suffix .flexipage-meta.xml, and are stored in the flexipages directory. If you specify a different type of file, this command opens your org’s home page.
309
+
310
+ USAGE
311
+ $ sfdx force:source:open -f <filepath> [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel
312
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
313
+
314
+ OPTIONS
315
+ -f, --sourcefile=sourcefile (required) file to edit
316
+
317
+ -r, --urlonly generate a navigation URL; don’t
318
+ launch the editor
319
+
320
+ -u, --targetusername=targetusername username or alias for the target
321
+ org; overrides default target org
322
+
323
+ --apiversion=apiversion override the api version used for
324
+ api requests made by this command
325
+
326
+ --json format output as json
327
+
328
+ --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
329
+ this command invocation
330
+
331
+ DESCRIPTION
332
+ Opens the specified Lightning Page in Lightning App Builder. Lightning Page files have the suffix .flexipage-meta.xml,
333
+ and are stored in the flexipages directory. If you specify a different type of file, this command opens your org’s
334
+ home page.
335
+
336
+ EXAMPLES
337
+ $ sfdx force:source:open -f path/to/source
338
+ $ sfdx force:source:open -r -f path/to/source
339
+ $ sfdx force:source:open -f path/to/source -u [email protected]
340
+ ```
341
+
342
+ _ See code: [ src/commands/force/source/open.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.0.5/src/commands/force/source/open.ts ) _
343
+
304
344
## ` sfdx force:source:retrieve [-p <array> | -x <filepath> | -m <array>] [-w <minutes>] [-n <array>] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
305
345
306
346
retrieve source from an org
@@ -309,7 +349,7 @@ retrieve source from an org
309
349
retrieve source from an org
310
350
311
351
USAGE
312
- $ sfdx force:source:retrieve [-p <array> | -x <filepath> | -m <array>] [-w <minutes>] [-n <array>] [-u <string>] [-a
352
+ $ sfdx force:source:retrieve [-p <array> | -x <filepath> | -m <array>] [-w <minutes>] [-n <array>] [-u <string>] [-a
313
353
<string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
314
354
315
355
OPTIONS
0 commit comments