Salesforce DX Developer Guide
jNewer Version Available
Create and Manage Org Shapes
Create an org shape to mimic the baseline setup (features, limits, edition, and Metadata
API settings) of a source org without the extraneous data and metadata. If the features, settings,
or licenses of that org change, you can capture those updates by recreating the org shape. You can
have only one active org shape at a time. Org shapes are internal system files and aren’t
viewable.
An org shape captures Metadata API settings, not all metadata types. For example, customizations that appear in the org, such as Lightning Experience Themes, aren’t included as part of org shape. See Settings in the Metadata API Guide for the complete list.
An org shape includes org preference and permissions. It doesn’t include data entries such as AddressSettings.
-
Authorize both your Dev Hub org and the source org. Run this command for each org.
1sf auth web login --alias -
Create the org shape for the source org. This command kicks off an asynchronous process to
create the org shape.
1sf org create shape --target-org <source org username/alias> 2Successfully created org shape for 3SRB0000000TXbnOCG. -
Check the status of the shape:create command.
1sf org shape list1=== Org Shapes 2ALIAS USERNAME ORG ID SHAPE STATUS CREATED BY CREATED DATE 3────── ──────── ────────────────── ──────────── ────────── ───────────── 4SrcOrg me@my.org 00DB1230000Ifx5MAC InProgress me@my.org 2020-08-06You can use the org shape after the status is Active:
1=== Org Shapes 2ALIAS USERNAME ORG ID SHAPE STATUS CREATED BY CREATED DATE 3────── ───────── ────────────────── ──────────── ──────────── ──────────── 4SrcOrg me@my.org 00DB1230000Ifx5MAC Active me@my.org 2020-08-06
If you run the sf org create shape command again for
this org, the previous shape is marked inactive and replaced by a new active shape.
If you don’t want to create scratch orgs based on this shape, you can delete the org shape. To delete an org shape:
1sf org delete shape --target-org <username/alias>