Salesforce DX Developer Guide

How Salesforce Developer Experience Changes the Way You Work
Project Setup
Salesforce CLI Configuration and Tips
Sample Repository on GitHub
Create a Salesforce DX Project
Create a Salesforce DX Project from Existing Source
Retrieve Source from an Existing Managed Package
Retrieve Unpackaged Source Defined in a package.xml File
Retrieve Unpackaged Source by Creating a Temporary Unmanaged Package
Convert the Metadata API Source
Link a Namespace to a Dev Hub Org
Salesforce DX Project Configuration
Authorization
Scratch Orgs
Development
Build and Release Your App
Develop Second-Generation Packages (Beta)
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Newer Version Available

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

Retrieve Unpackaged Source by Creating a Temporary Unmanaged Package

Don’t already have your source defined in a package.xml file? No worries. To simplify the source retrieval process, you can use the Unmanaged Package UI to define what you want to retrieve. Create an unmanaged package in your sandbox, and add your app’s source to it.
  1. Open the sandbox org that contains your metadata. 
    1sfdx force:org:open -u <username> --path one/one.app
    You can use the sandbox username or an alias.
  2. Open All Setup.
  3. Open Package Manager.
  4. Create a package with the name of your application.
  5. Add the metadata source to the package.
  6. In your Salesforce DX project, create a folder for the MDAPI retrieve, for example, mdapipkg.
  7. Retrieve the metadata. 
    1sfdx force:mdapi:retrieve -s -r ./mdapipkg -u <username> -p <package name>
    The -s parameter indicates that you’re retrieving a single package. The package name is the name you used in step 4.
  8. Check the status of the retrieve.
    When you run force:mdapi:retrieve, the job ID, target username, and retrieve directory are stored, so you don’t have to specify these required parameters to check the status. These stored values are overwritten when you run the force:mdapi:retrieve again. 
    1sfdx force:mdapi:retrieve:report
    If you want to check the status of a different retrieve operation, specify the retrieve directory and job ID on the command line, which overrides any stored values.
  9. Unzip the zip file.
  10. (Optional) Delete the zip file.

After you retrieve your source, you can delete or refresh your sandbox or delete the package definition in the sandbox org. Now that you have the source, you don’t need the resources.

Next, convert the metadata source.