---
schema_version: "1"
id: e763267be922fb1d236a4663b48b528e64319cb6c944cb1c79f377ee3585d942
title: template generate lightning event
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/salesforcedx/sfclireference/guides/template/cli_reference_template_generate_lightning_event.md
canonical_url: https://developer.salesforce.com/docs/platform/salesforce-cli-reference/guide/cli_reference_template_generate_lightning_event.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: f2f93a5de61aab4c33fcd54b5ea310196f17e1c5ccf96b3b2efa63a95e22acdf
products:
  - Salesforce CLI Command Reference
  - salesforcedx
---
<!-- prettier-ignore-start -->

# template generate lightning event

Generate a Lightning Event.

## Description for template generate lightning event

Generates a Lightning Event 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 event

`force:lightning:event:create`

`lightning:generate:event`

## Flags

| Flag Name (Long) | Flag Name (Short) | Description |
|------------------|-------------------|-------------|
| <code>&#8209;&#8209;api&#8209;version</code> | N/A | **Type:** Value<br><br>Override the api version used for api requests made by this command |
| <code>&#8209;&#8209;flags&#8209;dir</code> | N/A | **Type:** Value<br><br>Import flag values from a directory. |
| <code>&#8209;&#8209;json</code> | N/A | **Type:** Boolean<br><br>Format output as json. |
| <code>&#8209;&#8209;name</code> | <code>&#8209;n</code> | **Type:** Value<br>**Required**<br><br>Name of the generated Lightning Event.<br><br>The name can be up to 40 characters and must start with a letter. |
| <code>&#8209;&#8209;output&#8209;dir</code> | <code>&#8209;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>&#8209;&#8209;template</code> | <code>&#8209;t</code> | **Type:** Value<br>**Valid Values:** `DefaultLightningEvt`<br>**Default value:** `DefaultLightningEvt`<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 event

Generate the metadata files for a Lightning event bundle called "myevent" in the current directory:

```shell
sf template generate lightning event --name myevent
```

Similar to previous example, but generate the files in the "force-app/main/default/aura" directory:

```shell
sf template generate lightning event --name myevent --output-dir force-app/main/default/aura
```
<!-- prettier-ignore-end -->
