Salesforce DX Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
How Salesforce Developer Experience (DX) Tooling Changes the Way You Work
Provide Developers Access to Salesforce DX Tools
Project Setup
Authorization
Metadata Coverage
Scratch Orgs
Sandboxes
Track Changes Between Your Project and Org
Work with Data
Development
Develop Against Any Org
Assign a Permission Set
Create Lightning Apps and Aura Components
Create Lightning Web Components
Create an Apex Class
Create an Apex Trigger
Create a Custom Object
Execute Anonymous Apex
Run Apex Tests
Build and Release Your App
Unlocked Packages
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Create a Custom Object

You can use Salesforce CLI to generate the metadata files for new custom objects in your local Salesforce DX project.
  1. Open a terminal (macOS and Linux) or command prompt Windows and change to your Salesforce DX project directory.
  2. Run the interactive schema generate sobject command. You must specify a label for your new custom object with the --label flag. The command uses this label to provide intelligent suggestions for other object properties, such as its API name and plural label. 
    sf schema generate sobject --label "New Object"

    Answer all the questions about your new object, such as the location of the generated files in your Salesforce DX project and whether to enable various object properties.

After you create your custom object:
  • Create a custom field on your new object with the interactive schema generate field command, which generates the necessary metadata files in your project. You can also use the command to create a custom field on a standard object, such as Account.
  • Create a custom tab for your new object with the schema generate tab command.

Then deploy your new custom object to your org. 

sf project deploy start --metadata CustomObject:NewObject__c --target-org myscratch

The first time you deploy your new custom object to a source-tracking org, the org creates additional properties and sets new defaults on it. For this reason, we recommend that you immediately retrieve the custom object so your local source files are updated with this new information.