Generate a bundle for an Aura component or a Lightning web component.
Description for template generate lightning component
Generates the bundle in the specified directory or the current working directory. The bundle consists of multiple files in a directory with the designated name. Lightning web components are contained in the directory with name “lwc”, Aura components in “aura”.
To generate a Lightning web component, pass “–type lwc” to the command. If you don’t specify –type, Salesforce CLI generates an Aura component by default.
Aliases for template generate lightning component
force:lightning:component:create
lightning:generate:component
Flags
Flag Name (Long)
Flag Name (Short)
Description
‑‑api‑version
N/A
Type: Value
Override the api version used for api requests made by this command
‑‑flags‑dir
N/A
Type: Value
Import flag values from a directory.
‑‑json
N/A
Type: Boolean
Format output as json.
‑‑name
‑n
Type: Value Required
Name of the generated Lightning Component.
The name can be up to 40 characters and must start with a letter.
‑‑output‑dir
‑d
Type: Value Default value:.
Directory for saving the created files.
The location can be an absolute path or relative to the current working directory. The default is the current directory.
‑‑template
‑t
Type: Value Valid Values:default, analyticsDashboard, analyticsDashboardWithStep, typescript Default value:default
Template to use for file creation.
Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn’t specified, the CLI command automatically selects the template based on the “defaultLwcLanguage” field in the DX project’s “sfdx-project.json” file.
‑‑type
N/A
Type: Value Valid Values:aura, lwc Default value:aura
Type of the component bundle.
Examples for template generate lightning component
Generate the metadata files for an Aura component bundle in the current directory:
j