Generate a Lightning Interface.
Description for template generate lightning interface
Generates a Lightning Interface bundle in the specified directory or the current working directory. The bundle consists of multiple files in a folder with the designated name.
Aliases for template generate lightning interface
force:lightning:interface:create
lightning:generate:interface
Flags
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
| <code>‑‑api‑version</code> | N/A | Type: Value<br><br>Override the api version used for api requests made by this command |
| <code>‑‑flags‑dir</code> | N/A | Type: Value<br><br>Import flag values from a directory. |
| <code>‑‑json</code> | N/A | Type: Boolean<br><br>Format output as json. |
| <code>‑‑name</code> | <code>‑n</code> | Type: Value<br>Required<br><br>Name of the generated Lightning Interface.<br><br>The name can be up to 40 characters and must start with a letter. |
| <code>‑‑output‑dir</code> | <code>‑d</code> | Type: Value<br>Default value: .<br><br>Directory for saving the created files.<br><br>The location can be an absolute path or relative to the current working directory. The default is the current directory. |
| <code>‑‑template</code> | <code>‑t</code> | Type: Value<br>Valid Values: DefaultLightningIntf<br>Default value: DefaultLightningIntf<br><br>Template to use for file creation.<br><br>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. |
Examples for template generate lightning interface
Generate the metadata files for a Lightning interface bundle called "myinterface" in the current directory:
sf template generate lightning interface --name myinterface
Similar to the previous example but generate the files in the "force-app/main/default/aura" directory:
sf template generate lightning interface --name myinterface --output-dir force-app/main/default/aura