scc-universal 1.2.2 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,812 @@
1
+ <!-- Source: https://github.com/salesforcecli/cli -->
2
+ <!-- Last verified: SF CLI v2.132.0 — 2026-04-09 -->
3
+
4
+ # SF CLI Commands — Reference
5
+
6
+ ## Command Index
7
+
8
+ | Topic | Command | Description |
9
+ |---|---|---|
10
+ | org | `sf org login web` | Browser-based OAuth login |
11
+ | org | `sf org login jwt` | JWT-based non-interactive login |
12
+ | org | `sf org login sfdx-url` | Auth via SFDX auth URL file |
13
+ | org | `sf org logout` | Log out of an org |
14
+ | org | `sf org list` | List all authenticated orgs |
15
+ | org | `sf org open` | Open org in browser |
16
+ | org | `sf org display` | Display org info (access token, instance URL) |
17
+ | org | `sf org create scratch` | Create a scratch org |
18
+ | org | `sf org delete scratch` | Delete a scratch org |
19
+ | org | `sf org create sandbox` | Create a sandbox |
20
+ | org | `sf org delete sandbox` | Delete a sandbox |
21
+ | org | `sf org resume sandbox` | Resume sandbox creation |
22
+ | org | `sf org create user` | Create a user in an org |
23
+ | org | `sf org display user` | Display user info |
24
+ | org | `sf org list users` | List users in an org |
25
+ | org | `sf org assign permset` | Assign permission set to user |
26
+ | org | `sf org assign permsetlicense` | Assign permission set license |
27
+ | project | `sf project deploy start` | Deploy source to an org |
28
+ | project | `sf project deploy validate` | Validate deploy without committing |
29
+ | project | `sf project deploy quick` | Quick deploy a validated deployment |
30
+ | project | `sf project deploy report` | Check deploy status |
31
+ | project | `sf project deploy resume` | Resume a failed/cancelled deploy |
32
+ | project | `sf project deploy cancel` | Cancel an in-progress deploy |
33
+ | project | `sf project retrieve start` | Retrieve source from an org |
34
+ | project | `sf project retrieve preview` | Preview what will be retrieved |
35
+ | project | `sf project generate` | Generate a new SFDX project |
36
+ | project | `sf project generate manifest` | Generate package.xml manifest |
37
+ | project | `sf project convert source` | Convert source to metadata format |
38
+ | project | `sf project convert mdapi` | Convert metadata to source format |
39
+ | project | `sf project list ignored` | List files ignored by .forceignore |
40
+ | apex | `sf apex run` | Execute anonymous Apex |
41
+ | apex | `sf apex run test` | Run Apex tests |
42
+ | apex | `sf apex tail log` | Stream debug logs in real time |
43
+ | apex | `sf apex get log` | Retrieve a specific debug log |
44
+ | apex | `sf apex list log` | List recent debug logs |
45
+ | apex | `sf apex generate class` | Generate Apex class from template |
46
+ | apex | `sf apex generate trigger` | Generate Apex trigger from template |
47
+ | data | `sf data query` | Run a SOQL query |
48
+ | data | `sf data query resume` | Resume a bulk query |
49
+ | data | `sf data search` | Run a SOSL search |
50
+ | data | `sf data create record` | Create a single record |
51
+ | data | `sf data update record` | Update a single record |
52
+ | data | `sf data delete record` | Delete a single record |
53
+ | data | `sf data upsert bulk` | Bulk upsert records from CSV |
54
+ | data | `sf data delete bulk` | Bulk delete records from CSV |
55
+ | data | `sf data export tree` | Export data as SObject tree |
56
+ | data | `sf data import tree` | Import SObject tree data |
57
+ | data | `sf data resume` | Resume a bulk data operation |
58
+ | package | `sf package create` | Create a package |
59
+ | package | `sf package update` | Update package properties |
60
+ | package | `sf package list` | List packages in Dev Hub |
61
+ | package | `sf package delete` | Delete a package |
62
+ | package | `sf package version create` | Create a package version |
63
+ | package | `sf package version list` | List package versions |
64
+ | package | `sf package version promote` | Promote a version to released |
65
+ | package | `sf package version update` | Update version properties |
66
+ | package | `sf package version delete` | Delete a package version |
67
+ | package | `sf package version report` | Get details of a package version |
68
+ | package | `sf package install` | Install a package in an org |
69
+ | package | `sf package uninstall` | Uninstall a package |
70
+ | package | `sf package installed list` | List installed packages |
71
+ | agent | `sf agent create` | Create an AI agent |
72
+ | agent | `sf agent generate spec` | Generate agent spec file |
73
+ | agent | `sf agent generate test` | Generate agent test cases |
74
+ | agent | `sf agent test run` | Run agent tests |
75
+ | agent | `sf agent test resume` | Resume agent test run |
76
+ | agent | `sf agent preview` | Preview an agent |
77
+ | agent | `sf agent activate` | Activate an agent |
78
+ | agent | `sf agent deactivate` | Deactivate an agent |
79
+ | config | `sf config get` | Get a config value |
80
+ | config | `sf config list` | List all config values |
81
+ | config | `sf config set` | Set a config value |
82
+ | config | `sf config unset` | Unset a config value |
83
+ | alias | `sf alias list` | List all aliases |
84
+ | alias | `sf alias set` | Set an alias |
85
+ | alias | `sf alias unset` | Remove an alias |
86
+ | sobject | `sf sobject describe` | Describe an SObject |
87
+ | sobject | `sf sobject list` | List SObjects in an org |
88
+ | api | `sf api request rest` | Make a REST API request |
89
+ | api | `sf api request graphql` | Make a GraphQL API request |
90
+ | schema | `sf schema generate sobject` | Generate SObject metadata |
91
+ | schema | `sf schema generate field` | Generate field metadata |
92
+ | schema | `sf schema generate tab` | Generate tab metadata |
93
+ | schema | `sf schema generate platformevent` | Generate platform event metadata |
94
+ | lightning | `sf lightning generate component` | Generate Lightning component (LWC/Aura) |
95
+ | lightning | `sf lightning generate event` | Generate Lightning event |
96
+ | lightning | `sf lightning generate interface` | Generate Lightning interface |
97
+ | plugins | `sf plugins install` | Install a CLI plugin |
98
+ | plugins | `sf plugins uninstall` | Uninstall a CLI plugin |
99
+ | plugins | `sf plugins update` | Update installed plugins |
100
+ | plugins | `sf plugins link` | Link a local plugin |
101
+ | plugins | `sf plugins discover` | Discover available plugins |
102
+ | logic | `sf logic run test` | Run Flow tests |
103
+ | utility | `sf doctor` | Diagnose CLI issues |
104
+ | utility | `sf info releasenotes display` | Show release notes |
105
+ | utility | `sf update` | Update the CLI |
106
+ | utility | `sf version` | Display CLI version |
107
+ | utility | `sf autocomplete` | Set up shell autocomplete |
108
+
109
+ ---
110
+
111
+ ## org — Organization Management
112
+
113
+ ### sf org login web
114
+
115
+ | Flag | Required | Description |
116
+ |---|---|---|
117
+ | `--alias, -a` | No | Alias for the org |
118
+ | `--instance-url, -r` | No | Login URL (default: login.salesforce.com; use test.salesforce.com for sandboxes) |
119
+ | `--set-default, -d` | No | Set as default target org |
120
+ | `--set-default-dev-hub, -v` | No | Set as default Dev Hub |
121
+ | `--browser` | No | Browser to use for login |
122
+ | `--client-id` | No | Connected App consumer key |
123
+
124
+ ### sf org login jwt
125
+
126
+ | Flag | Required | Description |
127
+ |---|---|---|
128
+ | `--client-id, -i` | Yes | Connected App consumer key |
129
+ | `--jwt-key-file, -f` | Yes | Path to private key file (.key) |
130
+ | `--username, -o` | Yes | Login username |
131
+ | `--alias, -a` | No | Alias for the org |
132
+ | `--instance-url, -r` | No | Login URL |
133
+ | `--set-default, -d` | No | Set as default target org |
134
+ | `--set-default-dev-hub, -v` | No | Set as default Dev Hub |
135
+
136
+ ### sf org login sfdx-url
137
+
138
+ | Flag | Required | Description |
139
+ |---|---|---|
140
+ | `--sfdx-url-file, -f` | Yes | Path to file containing SFDX auth URL |
141
+ | `--alias, -a` | No | Alias for the org |
142
+ | `--set-default, -d` | No | Set as default target org |
143
+ | `--set-default-dev-hub, -v` | No | Set as default Dev Hub |
144
+
145
+ ### sf org list
146
+
147
+ | Flag | Required | Description |
148
+ |---|---|---|
149
+ | `--all` | No | Include expired, deleted, and unknown-status orgs |
150
+ | `--clean` | No | Remove all local org auth files with invalid orgs |
151
+ | `--skip-connection-status` | No | Skip connection status check (faster) |
152
+
153
+ ### sf org open
154
+
155
+ | Flag | Required | Description |
156
+ |---|---|---|
157
+ | `--target-org, -o` | No | Org to open (default: default org) |
158
+ | `--path, -p` | No | URL path to open (e.g., `/lightning/setup/SetupOneHome/home`) |
159
+ | `--url-only, -r` | No | Print URL instead of opening browser |
160
+ | `--browser` | No | Browser to use |
161
+
162
+ ### sf org display
163
+
164
+ | Flag | Required | Description |
165
+ |---|---|---|
166
+ | `--target-org, -o` | No | Org to display info for |
167
+ | `--verbose` | No | Show access token and connected status |
168
+
169
+ ### sf org create scratch
170
+
171
+ | Flag | Required | Description |
172
+ |---|---|---|
173
+ | `--definition-file, -f` | No | Path to scratch org definition file |
174
+ | `--target-dev-hub, -v` | No | Dev Hub for scratch org creation |
175
+ | `--alias, -a` | No | Alias for the scratch org |
176
+ | `--duration-days, -d` | No | Duration in days (1-30, default: 7) |
177
+ | `--set-default` | No | Set as default target org |
178
+ | `--edition, -e` | No | Salesforce edition (Developer, Enterprise, Group, Professional) |
179
+ | `--no-namespace` | No | Create without a namespace |
180
+ | `--wait, -w` | No | Minutes to wait (default: 6) |
181
+ | `--no-ancestors` | No | Do not include ancestors in scratch org |
182
+
183
+ ### sf org delete scratch
184
+
185
+ | Flag | Required | Description |
186
+ |---|---|---|
187
+ | `--target-org, -o` | Yes | Scratch org to delete |
188
+ | `--no-prompt, -p` | No | Skip confirmation prompt |
189
+
190
+ ### sf org create sandbox
191
+
192
+ | Flag | Required | Description |
193
+ |---|---|---|
194
+ | `--definition-file, -f` | No | Path to sandbox definition file |
195
+ | `--name, -n` | Yes | Name of the sandbox |
196
+ | `--target-org, -o` | No | Production org for sandbox |
197
+ | `--alias, -a` | No | Alias for the sandbox |
198
+ | `--set-default` | No | Set as default target org |
199
+ | `--wait, -w` | No | Minutes to wait (default: 30) |
200
+ | `--poll-interval, -i` | No | Seconds between status polls (default: 30) |
201
+ | `--clone, -c` | No | Name of sandbox to clone |
202
+ | `--license-type, -l` | No | License type (DEVELOPER, DEVELOPER_PRO, PARTIAL, FULL) |
203
+
204
+ ### sf org assign permset
205
+
206
+ | Flag | Required | Description |
207
+ |---|---|---|
208
+ | `--name, -n` | Yes | Permission set name(s) to assign |
209
+ | `--target-org, -o` | No | Target org |
210
+ | `--on-behalf-of, -b` | No | Username(s) to assign to |
211
+
212
+ ---
213
+
214
+ ## project — Source Deploy and Retrieve
215
+
216
+ ### sf project deploy start
217
+
218
+ | Flag | Required | Description |
219
+ |---|---|---|
220
+ | `--source-dir, -d` | No | Source directory path(s) to deploy |
221
+ | `--manifest, -x` | No | Path to package.xml manifest |
222
+ | `--metadata, -m` | No | Metadata component(s) to deploy (e.g., `ApexClass:MyClass`) |
223
+ | `--target-org, -o` | No | Target org for deployment |
224
+ | `--wait, -w` | No | Minutes to wait (default: 33) |
225
+ | `--test-level, -l` | No | Test level: NoTestRun, RunSpecifiedTests, RunLocalTests, RunAllTestsInOrg |
226
+ | `--tests, -t` | No | Apex test class names (with RunSpecifiedTests) |
227
+ | `--ignore-errors` | No | Continue deploy on component errors |
228
+ | `--ignore-warnings` | No | Ignore deploy warnings |
229
+ | `--dry-run` | No | Validate without saving (same as deploy validate) |
230
+ | `--pre-destructive-changes` | No | Manifest of components to delete before deploy |
231
+ | `--post-destructive-changes` | No | Manifest of components to delete after deploy |
232
+ | `--purge-on-delete` | No | Permanently delete components (not to recycle bin) |
233
+ | `--single-package` | No | Treat source-dir as a single package |
234
+ | `--api-version` | No | Override the API version |
235
+ | `--async` | No | Run asynchronously (don't wait) |
236
+ | `--concise` | No | Show concise output |
237
+ | `--verbose` | No | Show verbose output |
238
+ | `--json` | No | Output in JSON format |
239
+
240
+ ### sf project deploy validate
241
+
242
+ Same flags as `sf project deploy start`. Validates without committing the deploy to the org. After successful validation, use `sf project deploy quick` with the `--job-id` from the output.
243
+
244
+ ### sf project deploy quick
245
+
246
+ | Flag | Required | Description |
247
+ |---|---|---|
248
+ | `--job-id, -i` | Yes | Job ID from a successful validation |
249
+ | `--target-org, -o` | No | Target org |
250
+ | `--wait, -w` | No | Minutes to wait |
251
+ | `--async` | No | Run asynchronously |
252
+ | `--concise` | No | Show concise output |
253
+
254
+ ### sf project deploy report
255
+
256
+ | Flag | Required | Description |
257
+ |---|---|---|
258
+ | `--job-id, -i` | No | Job ID to check (defaults to most recent) |
259
+ | `--target-org, -o` | No | Target org |
260
+
261
+ ### sf project deploy resume
262
+
263
+ | Flag | Required | Description |
264
+ |---|---|---|
265
+ | `--job-id, -i` | No | Job ID to resume |
266
+ | `--target-org, -o` | No | Target org |
267
+ | `--wait, -w` | No | Minutes to wait |
268
+
269
+ ### sf project deploy cancel
270
+
271
+ | Flag | Required | Description |
272
+ |---|---|---|
273
+ | `--job-id, -i` | No | Job ID to cancel (defaults to most recent) |
274
+ | `--target-org, -o` | No | Target org |
275
+
276
+ ### sf project retrieve start
277
+
278
+ | Flag | Required | Description |
279
+ |---|---|---|
280
+ | `--source-dir, -d` | No | Source directory path(s) to retrieve into |
281
+ | `--manifest, -x` | No | Path to package.xml manifest |
282
+ | `--metadata, -m` | No | Metadata component(s) to retrieve |
283
+ | `--target-org, -o` | No | Org to retrieve from |
284
+ | `--package-name, -n` | No | Package name(s) to retrieve |
285
+ | `--wait, -w` | No | Minutes to wait (default: 33) |
286
+ | `--api-version` | No | Override the API version |
287
+ | `--ignore-conflicts` | No | Ignore source tracking conflicts |
288
+
289
+ ### sf project retrieve preview
290
+
291
+ | Flag | Required | Description |
292
+ |---|---|---|
293
+ | `--target-org, -o` | No | Org to preview retrieval from |
294
+ | `--concise` | No | Concise output |
295
+
296
+ ### sf project generate
297
+
298
+ | Flag | Required | Description |
299
+ |---|---|---|
300
+ | `--name, -n` | Yes | Project name |
301
+ | `--template, -t` | No | Template: standard, empty, analytics |
302
+ | `--output-dir, -d` | No | Output directory |
303
+ | `--namespace, -s` | No | Namespace |
304
+ | `--default-package-dir, -p` | No | Default package directory (default: force-app) |
305
+ | `--manifest, -x` | No | Generate manifest (package.xml) |
306
+
307
+ ### sf project generate manifest
308
+
309
+ | Flag | Required | Description |
310
+ |---|---|---|
311
+ | `--source-dir, -d` | No | Source directory to generate manifest from |
312
+ | `--metadata, -m` | No | Metadata types to include |
313
+ | `--name, -n` | No | Output file name (default: package.xml) |
314
+ | `--output-dir, -p` | No | Output directory |
315
+ | `--from-org` | No | Generate from org instead of source |
316
+ | `--type` | No | Manifest type: package, pre, post, destroy |
317
+
318
+ ---
319
+
320
+ ## apex — Apex Execution and Testing
321
+
322
+ ### sf apex run
323
+
324
+ | Flag | Required | Description |
325
+ |---|---|---|
326
+ | `--file, -f` | No | Path to Apex file to execute |
327
+ | `--target-org, -o` | No | Target org |
328
+
329
+ If `--file` is omitted, opens an interactive prompt for Apex input (stdin).
330
+
331
+ ### sf apex run test
332
+
333
+ | Flag | Required | Description |
334
+ |---|---|---|
335
+ | `--target-org, -o` | No | Target org |
336
+ | `--test-level, -l` | No | RunAllTestsInOrg, RunLocalTests, RunSpecifiedTests |
337
+ | `--class-names, -n` | No | Test class names (comma-separated) |
338
+ | `--suite-names, -s` | No | Test suite names (comma-separated) |
339
+ | `--tests, -t` | No | Test methods (ClassName.methodName) |
340
+ | `--code-coverage, -c` | No | Include code coverage results |
341
+ | `--output-dir, -d` | No | Directory for test result files |
342
+ | `--result-format, -r` | No | Format: human, tap, junit, json |
343
+ | `--wait, -w` | No | Minutes to wait (default: 10) |
344
+ | `--synchronous, -y` | No | Run tests synchronously |
345
+ | `--detailed-coverage` | No | Per-class code coverage detail |
346
+
347
+ ### sf apex tail log
348
+
349
+ | Flag | Required | Description |
350
+ |---|---|---|
351
+ | `--target-org, -o` | No | Target org |
352
+ | `--debug-level` | No | Debug level name (e.g., SFDC_DevConsole) |
353
+ | `--skip-trace-flag` | No | Skip setting a trace flag |
354
+ | `--color` | No | Colorize output |
355
+
356
+ ### sf apex get log
357
+
358
+ | Flag | Required | Description |
359
+ |---|---|---|
360
+ | `--log-id, -i` | No | ID of the log to retrieve |
361
+ | `--target-org, -o` | No | Target org |
362
+ | `--number, -n` | No | Number of most recent logs to get |
363
+ | `--output-dir, -d` | No | Directory to save log files |
364
+
365
+ ### sf apex list log
366
+
367
+ | Flag | Required | Description |
368
+ |---|---|---|
369
+ | `--target-org, -o` | No | Target org |
370
+
371
+ ### sf apex generate class
372
+
373
+ | Flag | Required | Description |
374
+ |---|---|---|
375
+ | `--name, -n` | Yes | Class name |
376
+ | `--output-dir, -d` | No | Output directory (default: current dir) |
377
+ | `--template, -t` | No | Template: DefaultApexClass, ApexException, ApexUnitTest, InboundEmailService |
378
+ | `--api-version` | No | Override API version |
379
+
380
+ ### sf apex generate trigger
381
+
382
+ | Flag | Required | Description |
383
+ |---|---|---|
384
+ | `--name, -n` | Yes | Trigger name |
385
+ | `--output-dir, -d` | No | Output directory |
386
+ | `--sobject, -s` | No | SObject for the trigger |
387
+ | `--event` | No | Trigger events (e.g., before insert, after update) |
388
+ | `--api-version` | No | Override API version |
389
+
390
+ ---
391
+
392
+ ## data — Data Operations
393
+
394
+ ### sf data query
395
+
396
+ | Flag | Required | Description |
397
+ |---|---|---|
398
+ | `--query, -q` | No | SOQL query string |
399
+ | `--file, -f` | No | File containing SOQL query |
400
+ | `--target-org, -o` | No | Target org |
401
+ | `--result-format, -r` | No | Format: human, csv, json |
402
+ | `--bulk` | No | Use Bulk API for large queries |
403
+ | `--wait, -w` | No | Minutes to wait for bulk query |
404
+ | `--all-rows` | No | Include deleted and archived records |
405
+ | `--use-tooling-api, -t` | No | Use Tooling API |
406
+ | `--perflog` | No | Log performance metrics |
407
+
408
+ ### sf data search
409
+
410
+ | Flag | Required | Description |
411
+ |---|---|---|
412
+ | `--query, -q` | Yes | SOSL search query |
413
+ | `--target-org, -o` | No | Target org |
414
+ | `--result-format, -r` | No | Format: human, csv, json |
415
+
416
+ ### sf data create record
417
+
418
+ | Flag | Required | Description |
419
+ |---|---|---|
420
+ | `--sobject, -s` | Yes | SObject type |
421
+ | `--values, -v` | Yes | Field values (e.g., `"Name='Acme' Industry='Tech'"`) |
422
+ | `--target-org, -o` | No | Target org |
423
+ | `--use-tooling-api, -t` | No | Use Tooling API |
424
+
425
+ ### sf data update record
426
+
427
+ | Flag | Required | Description |
428
+ |---|---|---|
429
+ | `--sobject, -s` | Yes | SObject type |
430
+ | `--record-id, -i` | No | Record ID to update |
431
+ | `--where, -w` | No | WHERE clause to identify record |
432
+ | `--values, -v` | Yes | New field values |
433
+ | `--target-org, -o` | No | Target org |
434
+ | `--use-tooling-api, -t` | No | Use Tooling API |
435
+
436
+ ### sf data delete record
437
+
438
+ | Flag | Required | Description |
439
+ |---|---|---|
440
+ | `--sobject, -s` | Yes | SObject type |
441
+ | `--record-id, -i` | No | Record ID to delete |
442
+ | `--where, -w` | No | WHERE clause to identify record |
443
+ | `--target-org, -o` | No | Target org |
444
+ | `--use-tooling-api, -t` | No | Use Tooling API |
445
+
446
+ ### sf data upsert bulk
447
+
448
+ | Flag | Required | Description |
449
+ |---|---|---|
450
+ | `--file, -f` | Yes | Path to CSV file |
451
+ | `--sobject, -s` | Yes | SObject type |
452
+ | `--external-id, -i` | Yes | External ID field for matching |
453
+ | `--target-org, -o` | No | Target org |
454
+ | `--wait, -w` | No | Minutes to wait |
455
+ | `--async` | No | Run asynchronously |
456
+
457
+ ### sf data delete bulk
458
+
459
+ | Flag | Required | Description |
460
+ |---|---|---|
461
+ | `--file, -f` | Yes | Path to CSV file with record IDs |
462
+ | `--sobject, -s` | Yes | SObject type |
463
+ | `--target-org, -o` | No | Target org |
464
+ | `--wait, -w` | No | Minutes to wait |
465
+
466
+ ### sf data export tree
467
+
468
+ | Flag | Required | Description |
469
+ |---|---|---|
470
+ | `--query, -q` | Yes | SOQL query defining records to export |
471
+ | `--target-org, -o` | No | Target org |
472
+ | `--plan, -p` | No | Generate multiple files with plan |
473
+ | `--output-dir, -d` | No | Output directory |
474
+ | `--prefix` | No | Filename prefix |
475
+
476
+ ### sf data import tree
477
+
478
+ | Flag | Required | Description |
479
+ |---|---|---|
480
+ | `--files, -f` | No | Data file(s) to import |
481
+ | `--plan, -p` | No | Plan file for multi-file import |
482
+ | `--target-org, -o` | No | Target org |
483
+
484
+ ---
485
+
486
+ ## package — Package Development
487
+
488
+ ### sf package create
489
+
490
+ | Flag | Required | Description |
491
+ |---|---|---|
492
+ | `--name, -n` | Yes | Package name |
493
+ | `--package-type, -t` | Yes | Type: Managed, Unlocked |
494
+ | `--path, -r` | Yes | Package directory path |
495
+ | `--target-dev-hub, -v` | No | Dev Hub org |
496
+ | `--description, -d` | No | Package description |
497
+ | `--no-namespace, -e` | No | Create without namespace |
498
+
499
+ ### sf package version create
500
+
501
+ | Flag | Required | Description |
502
+ |---|---|---|
503
+ | `--package, -p` | No | Package ID or alias |
504
+ | `--target-dev-hub, -v` | No | Dev Hub org |
505
+ | `--definition-file, -f` | No | Scratch org definition file |
506
+ | `--installation-key, -k` | No | Installation key for the version |
507
+ | `--installation-key-bypass, -x` | No | Bypass installation key |
508
+ | `--code-coverage, -c` | No | Calculate and store code coverage |
509
+ | `--version-name, -a` | No | Version name |
510
+ | `--version-number, -n` | No | Version number (Major.Minor.Patch.Build) |
511
+ | `--wait, -w` | No | Minutes to wait (default: 0) |
512
+ | `--skip-validation` | No | Skip package validation (creates beta) |
513
+
514
+ ### sf package version promote
515
+
516
+ | Flag | Required | Description |
517
+ |---|---|---|
518
+ | `--package, -p` | Yes | Package version ID (04t) to promote |
519
+ | `--target-dev-hub, -v` | No | Dev Hub org |
520
+ | `--no-prompt, -n` | No | Skip confirmation prompt |
521
+
522
+ ### sf package install
523
+
524
+ | Flag | Required | Description |
525
+ |---|---|---|
526
+ | `--package, -p` | Yes | Package version ID (04t) or alias |
527
+ | `--target-org, -o` | No | Org to install into |
528
+ | `--installation-key, -k` | No | Installation key |
529
+ | `--wait, -w` | No | Minutes to wait (default: 10) |
530
+ | `--publish-wait` | No | Minutes to wait for package to become available |
531
+ | `--no-prompt, -b` | No | Skip confirmation |
532
+ | `--security-type, -s` | No | Security type: AllUsers, AdminsOnly |
533
+ | `--upgrade-type, -t` | No | Upgrade type: DeprecateOnly, Mixed, Delete |
534
+ | `--apex-compile, -a` | No | Compile: all, package |
535
+
536
+ ### sf package installed list
537
+
538
+ | Flag | Required | Description |
539
+ |---|---|---|
540
+ | `--target-org, -o` | No | Target org |
541
+
542
+ ---
543
+
544
+ ## agent — Agentforce / AI Agent Management
545
+
546
+ ### sf agent create
547
+
548
+ | Flag | Required | Description |
549
+ |---|---|---|
550
+ | `--target-org, -o` | No | Target org |
551
+
552
+ > Note: `sf agent` commands are actively evolving. Run `sf agent <command> --help` for the latest flags.
553
+
554
+ ### sf agent generate spec
555
+
556
+ | Flag | Required | Description |
557
+ |---|---|---|
558
+ | `--output-dir, -d` | No | Output directory |
559
+ | `--target-org, -o` | No | Target org |
560
+
561
+ ### sf agent generate test
562
+
563
+ | Flag | Required | Description |
564
+ |---|---|---|
565
+ | `--spec-file, -f` | Yes | Agent spec file |
566
+ | `--output-dir, -d` | No | Output directory |
567
+ | `--target-org, -o` | No | Target org |
568
+
569
+ ### sf agent test run
570
+
571
+ | Flag | Required | Description |
572
+ |---|---|---|
573
+ | `--name, -n` | No | Agent test name |
574
+ | `--target-org, -o` | No | Target org |
575
+ | `--wait, -w` | No | Minutes to wait |
576
+ | `--result-format, -r` | No | Output format |
577
+
578
+ ### sf agent preview
579
+
580
+ | Flag | Required | Description |
581
+ |---|---|---|
582
+ | `--name, -n` | No | Agent name |
583
+ | `--target-org, -o` | No | Target org |
584
+
585
+ ---
586
+
587
+ ## config — Configuration
588
+
589
+ ### sf config set
590
+
591
+ | Flag | Required | Description |
592
+ |---|---|---|
593
+ | (positional) | Yes | Key=value pairs (e.g., `target-org=myOrg`) |
594
+ | `--global, -g` | No | Set globally (all projects) |
595
+
596
+ **Common config keys:**
597
+
598
+ | Key | Description |
599
+ |---|---|
600
+ | `target-org` | Default org for commands |
601
+ | `target-dev-hub` | Default Dev Hub org |
602
+ | `org-api-version` | Default API version |
603
+ | `org-isv-debugger-sid` | ISV debugger session ID |
604
+ | `org-isv-debugger-url` | ISV debugger URL |
605
+ | `org-max-query-limit` | Max SOQL query results |
606
+ | `org-instance-url` | Default instance URL |
607
+
608
+ ### sf config list
609
+
610
+ No flags. Lists all set config values (local and global).
611
+
612
+ ### sf config get
613
+
614
+ | Flag | Required | Description |
615
+ |---|---|---|
616
+ | (positional) | Yes | Config key(s) to get |
617
+
618
+ ### sf config unset
619
+
620
+ | Flag | Required | Description |
621
+ |---|---|---|
622
+ | (positional) | Yes | Config key(s) to unset |
623
+ | `--global, -g` | No | Unset globally |
624
+
625
+ ---
626
+
627
+ ## alias — Alias Management
628
+
629
+ ### sf alias set
630
+
631
+ | Flag | Required | Description |
632
+ |---|---|---|
633
+ | (positional) | Yes | Alias=value pairs (e.g., `myOrg=user@example.com`) |
634
+
635
+ ### sf alias list
636
+
637
+ No flags. Lists all aliases.
638
+
639
+ ### sf alias unset
640
+
641
+ | Flag | Required | Description |
642
+ |---|---|---|
643
+ | (positional) | Yes | Alias name(s) to remove |
644
+
645
+ ---
646
+
647
+ ## sobject — SObject Metadata
648
+
649
+ ### sf sobject describe
650
+
651
+ | Flag | Required | Description |
652
+ |---|---|---|
653
+ | `--sobject, -s` | Yes | SObject API name |
654
+ | `--target-org, -o` | No | Target org |
655
+ | `--use-tooling-api, -t` | No | Use Tooling API |
656
+
657
+ ### sf sobject list
658
+
659
+ | Flag | Required | Description |
660
+ |---|---|---|
661
+ | `--sobject-type, -s` | No | Type filter: all, custom, standard |
662
+ | `--target-org, -o` | No | Target org |
663
+
664
+ ---
665
+
666
+ ## api — Direct API Calls
667
+
668
+ ### sf api request rest
669
+
670
+ | Flag | Required | Description |
671
+ |---|---|---|
672
+ | (positional) | Yes | REST API URL path (e.g., `/services/data/vXX.0/sobjects`) |
673
+ | `--target-org, -o` | No | Target org |
674
+ | `--method` | No | HTTP method: GET, POST, PATCH, PUT, DELETE (default: GET) |
675
+ | `--body` | No | Request body (file path or inline JSON) |
676
+ | `--header, -H` | No | HTTP headers |
677
+ | `--stream-to-file` | No | Stream large response to file |
678
+
679
+ ### sf api request graphql
680
+
681
+ | Flag | Required | Description |
682
+ |---|---|---|
683
+ | `--body, -b` | Yes | GraphQL query (file path or inline) |
684
+ | `--target-org, -o` | No | Target org |
685
+
686
+ ---
687
+
688
+ ## lightning — Component Generation
689
+
690
+ ### sf lightning generate component
691
+
692
+ | Flag | Required | Description |
693
+ |---|---|---|
694
+ | `--name, -n` | Yes | Component name |
695
+ | `--type, -t` | No | Type: lwc, aura (default: lwc) |
696
+ | `--output-dir, -d` | No | Output directory |
697
+ | `--template` | No | Template name |
698
+ | `--api-version` | No | Override API version |
699
+
700
+ ### sf lightning generate event
701
+
702
+ | Flag | Required | Description |
703
+ |---|---|---|
704
+ | `--name, -n` | Yes | Event name |
705
+ | `--output-dir, -d` | No | Output directory |
706
+ | `--api-version` | No | Override API version |
707
+
708
+ ### sf lightning generate interface
709
+
710
+ | Flag | Required | Description |
711
+ |---|---|---|
712
+ | `--name, -n` | Yes | Interface name |
713
+ | `--output-dir, -d` | No | Output directory |
714
+ | `--api-version` | No | Override API version |
715
+
716
+ ---
717
+
718
+ ## schema — Metadata Schema Generation
719
+
720
+ ### sf schema generate sobject
721
+
722
+ | Flag | Required | Description |
723
+ |---|---|---|
724
+ | `--label, -l` | Yes | SObject label |
725
+ | `--output-dir, -d` | No | Output directory |
726
+ | `--use-default-features` | No | Use default SObject features |
727
+
728
+ ### sf schema generate field
729
+
730
+ | Flag | Required | Description |
731
+ |---|---|---|
732
+ | `--label, -l` | Yes | Field label |
733
+ | `--object` | Yes | Parent SObject |
734
+ | `--output-dir, -d` | No | Output directory |
735
+
736
+ ### sf schema generate tab
737
+
738
+ | Flag | Required | Description |
739
+ |---|---|---|
740
+ | `--object` | Yes | SObject for the tab |
741
+ | `--directory, -d` | No | Output directory |
742
+ | `--icon, -i` | No | Tab icon number |
743
+
744
+ ### sf schema generate platformevent
745
+
746
+ | Flag | Required | Description |
747
+ |---|---|---|
748
+ | `--label, -l` | Yes | Platform event label |
749
+ | `--output-dir, -d` | No | Output directory |
750
+
751
+ ---
752
+
753
+ ## plugins — Plugin Management
754
+
755
+ ### sf plugins install
756
+
757
+ | Flag | Required | Description |
758
+ |---|---|---|
759
+ | (positional) | Yes | Plugin name (e.g., `@salesforce/plugin-packaging`) |
760
+ | `--force` | No | Force install without confirmation |
761
+
762
+ ### sf plugins uninstall
763
+
764
+ | Flag | Required | Description |
765
+ |---|---|---|
766
+ | (positional) | Yes | Plugin name to uninstall |
767
+
768
+ ### sf plugins update
769
+
770
+ No required flags. Updates all installed plugins.
771
+
772
+ ### sf plugins link
773
+
774
+ | Flag | Required | Description |
775
+ |---|---|---|
776
+ | (positional) | Yes | Path to local plugin directory |
777
+
778
+ ---
779
+
780
+ ## Utility Commands
781
+
782
+ ### sf doctor
783
+
784
+ Diagnoses CLI configuration issues. No required flags. Checks: Node.js version, CLI version, plugin compatibility, config validity.
785
+
786
+ ### sf info releasenotes display
787
+
788
+ | Flag | Required | Description |
789
+ |---|---|---|
790
+ | `--version, -v` | No | Show notes for a specific version |
791
+
792
+ ### sf update
793
+
794
+ | Flag | Required | Description |
795
+ |---|---|---|
796
+ | `--channel` | No | Update channel: stable, stable-rc, latest, latest-rc, nightly |
797
+
798
+ ### sf autocomplete
799
+
800
+ | Flag | Required | Description |
801
+ |---|---|---|
802
+ | (positional) | No | Shell: bash, zsh, powershell |
803
+
804
+ ---
805
+
806
+ ## Global Flags (Available on All Commands)
807
+
808
+ | Flag | Description |
809
+ |---|---|
810
+ | `--json` | Output result in JSON format |
811
+ | `--flags-dir` | Import flag values from a directory |
812
+ | `--help` | Show command help |