---
schema_version: "1"
id: aaf7ed1a27adac9faf6d4fc0603ca94a615cf5eb02e7d20e7e8b1030346f620f
title: schema generate platformevent
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/salesforcedx/sfclireference/guides/schema/cli_reference_schema_generate_platformevent.md
canonical_url: https://developer.salesforce.com/docs/platform/salesforce-cli-reference/guide/cli_reference_schema_generate_platformevent.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: cdb4ebe74f7a93a59ecb332bd708556e4d7f2db5b728b230da240d6b2ff27d9d
products:
  - Salesforce CLI Command Reference
  - salesforcedx
---
<!-- prettier-ignore-start -->

# schema generate platformevent

Generate metadata source files for a new platform event.

## Description for schema generate platformevent

This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the event's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other event properties, such as its API name.

## Aliases for schema generate platformevent

`generate:metadata:platformevent`

## Flags

| Flag Name (Long) | Flag Name (Short) | Description |
|------------------|-------------------|-------------|
| <code>&#8209;&#8209;flags&#8209;dir</code> | N/A | **Type:** Value<br><br>Import flag values from a directory. |
| <code>&#8209;&#8209;label</code> | <code>&#8209;l</code> | **Type:** Value<br>**Required**<br><br>The platform event's label. |

## Examples for schema generate platformevent

Create a platform event with the specified label:

```shell
sf schema generate platformevent --label "My Platform Event"
```
<!-- prettier-ignore-end -->