Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 80 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ $ npm install -g @salesforce/cli
$ sf COMMAND
running command...
$ sf (--version|-v)
@salesforce/cli/2.111.6 linux-x64 node-v24.11.0
@salesforce/cli/2.111.7 linux-x64 node-v22.20.0
$ sf --help [COMMAND]
USAGE
$ sf COMMAND
Expand Down Expand Up @@ -160,6 +160,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
- [`sf package version list`](#sf-package-version-list)
- [`sf package version promote`](#sf-package-version-promote)
- [`sf package version report`](#sf-package-version-report)
- [`sf package version retrieve`](#sf-package-version-retrieve)
- [`sf package version update`](#sf-package-version-update)
- [`sf package1 version create`](#sf-package1-version-create)
- [`sf package1 version create get`](#sf-package1-version-create-get)
Expand Down Expand Up @@ -5811,7 +5812,7 @@ FLAG DESCRIPTIONS
--installation-key-bypass flag is required.
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/convert.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/convert.ts)_

## `sf package create`

Expand Down Expand Up @@ -5890,7 +5891,7 @@ FLAG DESCRIPTIONS
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/create.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/create.ts)_

## `sf package delete`

Expand Down Expand Up @@ -5932,7 +5933,7 @@ EXAMPLES
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/delete.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/delete.ts)_

## `sf package install`

Expand Down Expand Up @@ -6031,7 +6032,7 @@ FLAG DESCRIPTIONS
- Delete: Delete removed components, except for custom objects and custom fields, that don't have dependencies.
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/install.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/install.ts)_

## `sf package install report`

Expand Down Expand Up @@ -6064,7 +6065,7 @@ EXAMPLES
$ sf package install report --request-id 0Hf... --target-org me@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/install/report.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/install/report.ts)_

## `sf package installed list`

Expand Down Expand Up @@ -6096,7 +6097,7 @@ EXAMPLES
$ sf package installed list --target-org me@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/installed/list.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/installed/list.ts)_

## `sf package list`

Expand Down Expand Up @@ -6134,7 +6135,7 @@ EXAMPLES
$ sf package list --target-dev-hub devhub@example.com --verbose
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/list.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/list.ts)_

## `sf package push-upgrade abort`

Expand Down Expand Up @@ -6173,7 +6174,7 @@ EXAMPLES
$ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/push-upgrade/abort.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/push-upgrade/abort.ts)_

## `sf package push-upgrade list`

Expand Down Expand Up @@ -6232,7 +6233,7 @@ EXAMPLES
$ sf package push-upgrade list --package 033xyz –-status Failed
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/push-upgrade/list.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/push-upgrade/list.ts)_

## `sf package push-upgrade report`

Expand Down Expand Up @@ -6274,7 +6275,7 @@ EXAMPLES
$ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub devhub@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/push-upgrade/report.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/push-upgrade/report.ts)_

## `sf package push-upgrade schedule`

Expand Down Expand Up @@ -6361,7 +6362,7 @@ FLAG DESCRIPTIONS
Overrides the value of the target-dev-hub configuration variable, if set.
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/push-upgrade/schedule.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/push-upgrade/schedule.ts)_

## `sf package uninstall`

Expand Down Expand Up @@ -6409,7 +6410,7 @@ EXAMPLES
$ sf package uninstall --package "Undesirable Package Alias"
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/uninstall.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/uninstall.ts)_

## `sf package uninstall report`

Expand Down Expand Up @@ -6442,7 +6443,7 @@ EXAMPLES
$ sf package uninstall report --request-id 06y... --target-org me@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/uninstall/report.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/uninstall/report.ts)_

## `sf package update`

Expand Down Expand Up @@ -6505,7 +6506,7 @@ FLAG DESCRIPTIONS
notified to upgrade to the recommended version.
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/update.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/update.ts)_

## `sf package version create`

Expand Down Expand Up @@ -6680,7 +6681,7 @@ FLAG DESCRIPTIONS
periods of no output from commands.
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/version/create.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/create.ts)_

## `sf package version create list`

Expand Down Expand Up @@ -6741,7 +6742,7 @@ EXAMPLES
$ sf package version create list --created-last-days 0 --status Success
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/version/create/list.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/create/list.ts)_

## `sf package version create report`

Expand Down Expand Up @@ -6784,7 +6785,7 @@ EXAMPLES
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/version/create/report.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/create/report.ts)_

## `sf package version delete`

Expand Down Expand Up @@ -6825,7 +6826,7 @@ EXAMPLES
$ sf package version delete --package 04t... --target-org devhub@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/version/delete.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/delete.ts)_

## `sf package version displayancestry`

Expand Down Expand Up @@ -6885,7 +6886,7 @@ FLAG DESCRIPTIONS
You can use the DOT code output in graph visualization software to create tree visualizations.
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/version/displayancestry.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/displayancestry.ts)_

## `sf package version displaydependencies`

Expand Down Expand Up @@ -6947,7 +6948,7 @@ FLAG DESCRIPTIONS
package, which must be installed last.
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/version/displaydependencies.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/displaydependencies.ts)_

## `sf package version list`

Expand Down Expand Up @@ -7023,7 +7024,7 @@ EXAMPLES
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/version/list.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/list.ts)_

## `sf package version promote`

Expand Down Expand Up @@ -7067,7 +7068,7 @@ EXAMPLES
$ sf package version promote --package "Awesome Package Alias"
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/version/promote.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/promote.ts)_

## `sf package version report`

Expand Down Expand Up @@ -7107,7 +7108,50 @@ EXAMPLES
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/version/report.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/report.ts)_

## `sf package version retrieve`

Retrieve package metadata for a specified package version. Package metadata can be retrieved for second-generation managed package versions or unlocked packages only.

```
USAGE
$ sf package version retrieve -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d
<value>]

FLAGS
-d, --output-dir=<value> [default: force-app] Path within your Salesforce DX project directory in which to
download the metadata. This directory must be empty.
-p, --package=<value> (required) Subscriber package version ID (starts with 04t).
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
configuration variable is already set.
--api-version=<value> Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Retrieve package metadata for a specified package version. Package metadata can be retrieved for second-generation
managed package versions or unlocked packages only.

Retrieving a package version downloads the metadata into the directory you specify.

When you run this command, specify the subscriber package version ID (starts with 04t) and the path to an empty
directory.

By default, the package version retrieve command is available to 2GP managed packages that were converted from 1GP. To
use this command with a managed package created using 2GP (not converted from 1GP) or with an unlocked package,
specify IsDevUsePkgZipRequested = true in the Package2VersionCreateRequest Tooling API object. If you run this command
and the zip folder with the package version’s source files is missing, confirm that IsDevUsePkgZipRequested is set to
true.

EXAMPLES
Retrieve package metadata for a converted subscriber package version ID (starts with 04t) into my-directory/ within your Salesforce DX project directory:
sf package version retrieve --package 04tXXX --output-dir my-directory/ --target-dev-hub devhub@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/retrieve.ts)_

## `sf package version update`

Expand Down Expand Up @@ -7160,7 +7204,7 @@ EXAMPLES
$ sf package version update --package 04t... --version-description "New Package Version Description"
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package/version/update.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package/version/update.ts)_

## `sf package1 version create`

Expand Down Expand Up @@ -7227,7 +7271,7 @@ FLAG DESCRIPTIONS
subscribers.
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package1/version/create.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package1/version/create.ts)_

## `sf package1 version create get`

Expand Down Expand Up @@ -7260,7 +7304,7 @@ EXAMPLES
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package1/version/create/get.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package1/version/create/get.ts)_

## `sf package1 version display`

Expand Down Expand Up @@ -7294,7 +7338,7 @@ EXAMPLES
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package1/version/display.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package1/version/display.ts)_

## `sf package1 version list`

Expand Down Expand Up @@ -7332,7 +7376,7 @@ FLAG DESCRIPTIONS
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
```

_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.22.4/src/commands/package1/version/list.ts)_
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.0/src/commands/package1/version/list.ts)_

## `sf plugins`

Expand All @@ -7355,7 +7399,7 @@ EXAMPLES
$ sf plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.51/src/commands/plugins/index.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.52/src/commands/plugins/index.ts)_

## `sf plugins discover`

Expand Down Expand Up @@ -7400,7 +7444,7 @@ EXAMPLES
$ sf plugins inspect @salesforce/plugin-packaging
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.51/src/commands/plugins/inspect.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.52/src/commands/plugins/inspect.ts)_

## `sf plugins install PLUGIN`

Expand Down Expand Up @@ -7449,7 +7493,7 @@ EXAMPLES
$ sf plugins install someuser/someplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.51/src/commands/plugins/install.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.52/src/commands/plugins/install.ts)_

## `sf plugins link PATH`

Expand Down Expand Up @@ -7480,7 +7524,7 @@ EXAMPLES
$ sf plugins link @salesforce/plugin-packaging
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.51/src/commands/plugins/link.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.52/src/commands/plugins/link.ts)_

## `sf plugins reset`

Expand All @@ -7495,7 +7539,7 @@ FLAGS
--reinstall Reinstall all plugins after uninstalling.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.51/src/commands/plugins/reset.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.52/src/commands/plugins/reset.ts)_

## `sf plugins trust verify`

Expand Down Expand Up @@ -7552,7 +7596,7 @@ EXAMPLES
$ sf plugins uninstall @salesforce/plugin-packaging
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.51/src/commands/plugins/uninstall.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.52/src/commands/plugins/uninstall.ts)_

## `sf plugins update`

Expand All @@ -7570,7 +7614,7 @@ DESCRIPTION
Update installed plugins.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.51/src/commands/plugins/update.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.52/src/commands/plugins/update.ts)_

## `sf project convert mdapi`

Expand Down
Loading
Loading