Newer Version Available

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

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.

An org shape captures Metadata API settings, not all metadata types. For example, customizations that appear in the org, such as Lightning Experience Themes, are not included as part of org shape. See Settings in the Metadata API Guide for the complete list.

Scratch org shapes are associated with a specific Salesforce release. Be sure to recreate the org shape after the source org is upgraded to the new Salesforce release.

Important

  1. Authorize both your Dev Hub org and the source org. Run this command for each org.
    1$ sfdx auth:web:login -a <alias>
  2. Create the org shape for the source org. This command kicks off an asynchronous process to create the org shape.
    1$ sfdx force:org:shape:create -u <source org username/alias>
    23SRB0000000TXbnOCG scratch org configuration (shape) was created in the source org.
  3. Check the status of the shape:create command.
    1$ sfdx force:org:shape:list
    1=== Org Shapes
    2ALIAS  USERNAME      ORG ID             SHAPE STATUS CREATED BY CREATED DATE
    3────── ───────────── ────────────────── ──────────── ────────── ────────────────────────────
    4SrcOrg me@my.org     00DB1230000Ifx5MAC InProgress   me@my.org  2020-08-06T19:07:11.000+0000

    You 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-06T19:07:11.000+0000

Delete Org Shapes

If you run the shape:create 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.

1$ sfdx force:org:shape:delete -u <username/alias>