Salesforce DX Developer Guide

How Salesforce Developer Experience Changes the Way You Work
Salesforce CLI Configuration and Tips
Project Setup
Authorization
Metadata Coverage
Scratch Orgs
Sandboxes
Development
Build and Release Your App
First-Generation Managed Packages
Second-Generation Managed Packages
Unlocked Packages
What’s a Package
Package-Based Development Model
Before You Create Unlocked Packages
Know Your Orgs
Create Org-Dependent Unlocked Packages (Beta)
Workflow for Unlocked Packages
Configure Packages
Project Configuration File for Packages
Keywords
Package Installation Key
Extract Dependency Information from Unlocked Packages
Understanding Namespaces
Share Release Notes and Post-Install Instructions
Best Practices for Unlocked Packages
Package IDs and Aliases
Frequently Used Packaging Operations
Create a Package
Push a Package Upgrade (Beta)
Install a Package
Migrate Deprecated Metadata from Unlocked Packages
Uninstall a Package
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Package Installation Key

To ensure the security of the metadata in your package, you must specify an installation key when creating a package version. Package creators provide the key to authorized subscribers so they can install the package. Package installers provide the key during installation, whether installing the package from the CLI or from a browser. An installation key is the first step during installation. The key ensures that no package information, such as the name or components, is disclosed until the correct installation key is supplied.
To set the installation key, add the --installationkey parameter to the command when you create the package version. This command creates a package and protects it with the installation key.
1sfdx force:package:version:create --package "Expense Manager" --installationkey "JSB7s8vXU93fI"

Supply the installation key when you install the package version in the target org.

1sfdx force:package:install --package "Expense Manager" --installationkey "JSB7s8vXU93fI”

Change the Installation Key for an Existing Package Version

You can change the installation key for an existing package version with the force:package:version:update command. 

1sfdx force:package:version:update --package "Expense Manager@1.2.0-4" --installationkey “HIF83kS8kS7C”

Create a Package Version Without an Installation Key

If you don’t require security measures to protect your package metadata, you can create a package version without an installation key.

1sfdx force:package:version:create --package "Expense Manager" --directory common \
2--tag 'Release 1.0.0' --installationkeybypass

Check Whether a Package Version Requires an Installation Key

To determine whether a package version requires an installation key, use either the force:package:version:list or force:package:version:report CLI command.