Salesforce CLI Command Reference

Salesforce CLI Command Reference
Release Notes
sf
sfdx (Deprecated)
Migrate sfdx-Style Commands to the New sf-Style
alias Namespace (Deprecated)
auth Namespace (Deprecated)
config Namespace (Deprecated)
doctor (Deprecated)
force Namespace (Deprecated)
analytics Commands (Deprecated)
apex Commands (Deprecated)
cmdt Commands (Deprecated)
community Commands (Deprecated)
data Commands (Deprecated)
lightning Commands (Deprecated)
limits Commands (Deprecated)
mdapi Commands (Deprecated)
org Commands (Deprecated)
package Commands (Deprecated)
package1 Commands (Deprecated)
force:package1:version:create (Deprecated)
force:package1:version:create:get (Deprecated)
force:package1:version:display (Deprecated)
force:package1:version:list (Deprecated)
project Commands (Deprecated)
schema Commands (Deprecated)
source Commands (Deprecated)
staticresource Commands (Deprecated)
user Commands (Deprecated)
visualforce Commands (Deprecated)
info Namespace (Deprecated)
Help for sfdx Commands
CLI Deprecation Policy
Discover Salesforce Plugins
PDF

package1 Commands (Deprecated)

Use the package1 commands to create and view first-generation package versions in your Dev Hub org.

force:package1:version:create (Deprecated)

Create a first-generation package version in the release org.

This command is deprecated. As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

Don't worry, command and its flags continue to work the same as before, and any scripts that use the command won’t break. However, we recommend that you start using the equivalent sf-style package1 version create command instead. Here’s how the flags changed between the old and new commands; if a flag isn't listed, the old and new names are the same:

  • Removed flag: --loglevel. Use the SF_LOG_LEVEL environment variable instead.
  • Changed flag name: Old name --apiversion. New name: --api-version.
  • Changed flag name: Old name --targetusername. New name: --target-org, with new short name -o.
  • Changed flag name: Old name --installationkey. New name: --installation-key.
  • Changed flag name: Old name --managedrelease. New name: --managed-release.
  • Changed flag name: Old name --packageid. New name: --package-id.
  • Changed flag name: Old name --packageversionid. New name: --package-version-id.
  • Changed flag name: Old name --postinstallurl. New name: --post-install-url.
  • Changed flag name: Old name --releasenotesurl. New name: --release-notes-url.
  • Changed flag name: Old name --requestid. New name: --request-id.

For background information about this change, read this blog post, which describes how we've updated many of the existing sfdx commands to use the improvements we made in sf. We improved this particular command on February 2, 2023.

Warning

Help for force:package1:version:create

The package version is based on the contents of the specified metadata package. Omit -m if you want to create an unmanaged package version.

Command Syntax

sfdx force:package1:version:create
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i PACKAGEID
-n NAME
[-d DESCRIPTION]
[-v VERSION]
[-m]
[-r RELEASENOTESURL]
[-p POSTINSTALLURL]
[-k INSTALLATIONKEY]
[-w WAIT]

Parameters

--json
Optional

Format output as JSON.

Type: boolean
--loglevel LOGLEVEL
Optional

The logging level for this command invocation. Logs are stored in $HOME/.sf/sf.log.

Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAME
Optional

A username or alias for the target org. Overrides the default target org.

Type: string
--apiversion APIVERSION
Optional

Override the API version used for API requests made by this command.

Type: string
-i | --packageid PACKAGEID
Required

ID of the metadata package (starts with 033) of which you’re creating a new version.

Type: id
-n | --name NAME
Required

Package version name.

Type: string
-d | --description DESCRIPTION
Optional

Package version description.

Type: string
-v | --version VERSION
Optional

Package version in major.minor format, for example, 3.2.

Type: string
-m | --managedreleased
Optional

Creates a managed package version. To create a beta version, don’t include this parameter.

Type: boolean
-r | --releasenotesurl RELEASENOTESURL
Optional

The release notes URL. This link is displayed in the package installation UI to provide release notes for this package version to subscribers.

Type: url
-p | --postinstallurl POSTINSTALLURL
Optional

The post-install instructions URL. The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.

Type: url
-k | --installationkey INSTALLATIONKEY
Optional

Installation key for creating the key-protected package. The default is null.

Type: string
-w | --wait WAIT
Optional

Minutes to wait for the package version to be created. The default is 2 minutes.

Type: minutes

Aliases for force:package1:version:create 

1force:package1:beta:version:create

force:package1:version:create:get (Deprecated)

Retrieve the status of a package version creation request.

This command is deprecated. As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

Don't worry, command and its flags continue to work the same as before, and any scripts that use the command won’t break. However, we recommend that you start using the equivalent sf-style package1 version create get command instead. Here’s how the flags changed between the old and new commands; if a flag isn't listed, the old and new names are the same:

  • Removed flag: --loglevel. Use the SF_LOG_LEVEL environment variable instead.
  • Changed flag name: Old name --apiversion. New name: --api-version.
  • Changed flag name: Old name --targetusername. New name: --target-org, with new short name -o.
  • Changed flag name: Old name --requestid. New name: --request-id.

For background information about this change, read this blog post, which describes how we've updated many of the existing sfdx commands to use the improvements we made in sf. We improved this particular command on February 2, 2023.

Warning

Examples for force:package1:version:create:get 

1sfdx force:package1:version:create:get -i 0HD...
1sfdx force:package1:version:create:get -i 0HD... -u devhub@example.com

Command Syntax

sfdx force:package1:version:create:get
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i REQUESTID

Parameters

--json
Optional

Format output as JSON.

Type: boolean
--loglevel LOGLEVEL
Optional

The logging level for this command invocation. Logs are stored in $HOME/.sf/sf.log.

Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAME
Optional

A username or alias for the target org. Overrides the default target org.

Type: string
--apiversion APIVERSION
Optional

Override the API version used for API requests made by this command.

Type: string
-i | --requestid REQUESTID
Required

The ID of the PackageUploadRequest.

Type: id

Aliases for force:package1:version:create:get 

1force:package1:beta:version:create:get

force:package1:version:display (Deprecated)

Display details about a first-generation package version.

This command is deprecated. As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

Don't worry, command and its flags continue to work the same as before, and any scripts that use the command won’t break. However, we recommend that you start using the equivalent sf-style package1 version display command instead. Here’s how the flags changed between the old and new commands; if a flag isn't listed, the old and new names are the same:

  • Removed flag: --loglevel. Use the SF_LOG_LEVEL environment variable instead.
  • Changed flag name: Old name --apiversion. New name: --api-version.
  • Changed flag name: Old name --targetusername. New name: --target-org, with new short name -o.
  • Changed flag name: Old name --packageversionid. New name: --package-version-id.

For background information about this change, read this blog post, which describes how we've updated many of the existing sfdx commands to use the improvements we made in sf. We improved this particular command on February 2, 2023.

Warning

Command Syntax

sfdx force:package1:version:display
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i PACKAGEVERSIONID

Parameters

--json
Optional

Format output as JSON.

Type: boolean
--loglevel LOGLEVEL
Optional

The logging level for this command invocation. Logs are stored in $HOME/.sf/sf.log.

Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAME
Optional

A username or alias for the target org. Overrides the default target org.

Type: string
--apiversion APIVERSION
Optional

Override the API version used for API requests made by this command.

Type: string
-i | --packageversionid PACKAGEVERSIONID
Required

ID (starts with 04t) of the metadata package version whose details you want to display.

Type: id

Aliases for force:package1:version:display 

1force:package1:beta:version:display

force:package1:version:list (Deprecated)

List package versions for the specified first-generation package or for the org.

This command is deprecated. As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

Don't worry, command and its flags continue to work the same as before, and any scripts that use the command won’t break. However, we recommend that you start using the equivalent sf-style package1 version list command instead. Here’s how the flags changed between the old and new commands; if a flag isn't listed, the old and new names are the same:

  • Removed flag: --loglevel. Use the SF_LOG_LEVEL environment variable instead.
  • Changed flag name: Old name --apiversion. New name: --api-version.
  • Changed flag name: Old name --targetusername. New name: --target-org, with new short name -o.
  • Changed flag name: Old name --packageid. New name: --package-id.

For background information about this change, read this blog post, which describes how we've updated many of the existing sfdx commands to use the improvements we made in sf. We improved this particular command on February 2, 2023.

Warning

Command Syntax

sfdx force:package1:version:list
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-i PACKAGEID]

Parameters

--json
Optional

Format output as JSON.

Type: boolean
--loglevel LOGLEVEL
Optional

The logging level for this command invocation. Logs are stored in $HOME/.sf/sf.log.

Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAME
Optional

A username or alias for the target org. Overrides the default target org.

Type: string
--apiversion APIVERSION
Optional

Override the API version used for API requests made by this command.

Type: string
-i | --packageid PACKAGEID
Optional

Metadata package ID (starts with 033) whose package versions you want to list. If not specified, shows all versions for all packages (managed and unmanaged) in the org.

Type: id

Aliases for force:package1:version:list 

1force:package1:beta:version:list