Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Wix Design System (WDS)

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

# wix app generate


Starts a process that guides you through adding an extension to your project. After you select an extension type, the CLI prompts you for its configuration details and then generates the extension's files in your project.

## Usage

```bash
wix app generate [flags]
```

## Flags

The following flags are available for the `wix app generate` command:

| Flag           | Description                             |
| -------------- | --------------------------------------- |
| `--type <type>`  | Generates an extension with the specified type. Can't be combined with `--params`. Accepted values for `<type>`: <br><br> <ul><li>`DASHBOARD_PAGE`</li><li>`DASHBOARD_MODAL`</li><li>`DASHBOARD_PLUGIN`</li><li>`DASHBOARD_MENU_PLUGIN`</li><li>`DASHBOARD_EXTERNAL_PAGE`</li><li>`EMBEDDED_SCRIPT`</li><li>`CUSTOM_ELEMENT`</li><li>`EDITOR_REACT_COMPONENT`</li><li>`FUNCTION_LIBRARY`</li><li>`SITE_PLUGIN`</li><li>`EVENT`</li><li>`SERVICE_PLUGIN`</li><li>`DATA_COLLECTION`</li><li>`APP_TOOLS`</li><li>`APP_SKILLS`</li><li>`HTTP_ENDPOINT`</li></ul> |
| `--params <json>` | Generates an extension non-interactively from a JSON object describing it, instead of the prompts. Can't be combined with `--type`. For the object's keys, see [Extension JSON object](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-commands/generate#extension-json-object). |

### Extension JSON object

The `<json>` argument of `--params` is a JSON object that describes one extension. It has these keys:

- `extensionType`: The extension type. It takes the values that `--type` accepts, and `CONTEXT_PROVIDER`, which can only be generated with `--params`.
- The keys of that extension type, which differ between types. For example, a dashboard page requires `title` and `route`.

[`wix app schema generate --type <type>`](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-commands/schema) prints the keys of one extension type and which of them are required.

The command takes this form, with one `"<key>":"<value>"` pair for each of the extension type's keys:

```bash
wix app generate --params '{"extensionType":"<type>","<key>":"<value>"}'
```

For example, this command generates a dashboard page titled `Settings` with the route `settings`:

```bash
wix app generate --params '{"extensionType":"DASHBOARD_PAGE","title":"Settings","route":"settings"}'
```

Flag	Description
`--type <type>`	Generates an extension with the specified type. Can't be combined with `--params`. Accepted values for `<type>`: `DASHBOARD_PAGE` `DASHBOARD_MODAL` `DASHBOARD_PLUGIN` `DASHBOARD_MENU_PLUGIN` `DASHBOARD_EXTERNAL_PAGE` `EMBEDDED_SCRIPT` `CUSTOM_ELEMENT` `EDITOR_REACT_COMPONENT` `FUNCTION_LIBRARY` `SITE_PLUGIN` `EVENT` `SERVICE_PLUGIN` `DATA_COLLECTION` `APP_TOOLS` `APP_SKILLS` `HTTP_ENDPOINT`
`--params <json>`	Generates an extension non-interactively from a JSON object describing it, instead of the prompts. Can't be combined with `--type`. For the object's keys, see Extension JSON object.