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 Lightning Web Components

You can use Salesforce CLI to create Lightning web components in your local Salesforce DX project. The generated files live in a lwc directory in a package directory of your project.

Want to develop your Lightning web components in a real-time preview of your Lightning app or Experience Cloud site? Try the new Local Dev experience, which lets you iterate faster on your components without deploying code or manually refreshing the preview.

Note

  1. Open a terminal (macOS and Linux) or command prompt Windows and change to your Salesforce DX project directory.
  2. Create the lwc directory in the location you want to generate the Lightning app and Aura components. For example, if you want to generate them in the default package directory, create the force-app/main/default/aura directory if it doesn’t exist.
  3. Create the Lightning web component; specify the component name with the --name flag and the lwc directory with the --output-dir flag. 
    sf lightning generate component --type lwc --name myLightningWebComponent --output-dir force-app/main/default/lwc

Use the project deploy start command to deploy your new Lightning web component to your org.

sf project deploy start --metadata LightningComponentBundle:myLightningWebComponent