app generate extension
command

Generates a new app extension. For a list of app extensions that you can generate using this command, refer to Supported extensions.

Each new app extension is created in a folder under extensions/. To learn more about the extensions file structure, refer to App structure and the documentation for your extension.

Anchor to flagsFlags

The following flags are available for the app generate extension command:

Anchor to --client-id <value> --client-id <value> string env: SHOPIFY_FLAG_CLIENT_ID: The Client ID of your app.
Anchor to --flavor <value> --flavor <value> string env: SHOPIFY_FLAG_FLAVOR: Choose a starting template for your extension, where applicable
Anchor to --no-color --no-color env: SHOPIFY_FLAG_NO_COLOR: Disable color output.
Anchor to --path <value> --path <value> string env: SHOPIFY_FLAG_PATH: The path to your app directory.
Anchor to --reset --reset env: SHOPIFY_FLAG_RESET: Reset all your settings.
Anchor to --verbose --verbose env: SHOPIFY_FLAG_VERBOSE: Increase the verbosity of the output.
Anchor to -c, --config <value> -c, --config <value> string env: SHOPIFY_FLAG_APP_CONFIG: The name of the app configuration.
Anchor to -n, --name <value> -n, --name <value> string env: SHOPIFY_FLAG_NAME: name of your Extension
Anchor to -t, --template <value> -t, --template <value> string env: SHOPIFY_FLAG_EXTENSION_TEMPLATE: Extension template
Anchor to -t, --type <value> -t, --type <value> string env: SHOPIFY_FLAG_EXTENSION_TYPE: Deprecated. Please use --template

appgenerateextension

--client-id <value>
The Client ID of your app.
```
string
```
--flavor <value>
Choose a starting template for your extension, where applicable
```
string
```
--no-color
Disable color output.
```
""
```
--path <value>
The path to your app directory.
```
string
```
--reset
Reset all your settings.
```
""
```
--verbose
Increase the verbosity of the output.
```
""
```
-c, --config <value>
The name of the app configuration.
```
string
```
-n, --name <value>
name of your Extension
```
string
```
-t, --template <value>
Extension template
```
string
```
-t, --type <value>
Deprecated. Please use --template
```
string
```

export interface appgenerateextension {
  /**
   * The Client ID of your app.
   * @environment SHOPIFY_FLAG_CLIENT_ID
   */
  '--client-id <value>'?: string

  /**
   * The name of the app configuration.
   * @environment SHOPIFY_FLAG_APP_CONFIG
   */
  '-c, --config <value>'?: string

  /**
   * Choose a starting template for your extension, where applicable
   * @environment SHOPIFY_FLAG_FLAVOR
   */
  '--flavor <value>'?: string

  /**
   * name of your Extension
   * @environment SHOPIFY_FLAG_NAME
   */
  '-n, --name <value>'?: string

  /**
   * Disable color output.
   * @environment SHOPIFY_FLAG_NO_COLOR
   */
  '--no-color'?: ''

  /**
   * The path to your app directory.
   * @environment SHOPIFY_FLAG_PATH
   */
  '--path <value>'?: string

  /**
   * Reset all your settings.
   * @environment SHOPIFY_FLAG_RESET
   */
  '--reset'?: ''

  /**
   * Extension template
   * @environment SHOPIFY_FLAG_EXTENSION_TEMPLATE
   */
  '-t, --template <value>'?: string

  /**
   * Deprecated. Please use --template
   * @environment SHOPIFY_FLAG_EXTENSION_TYPE
   */
  '-t, --type <value>'?: string

  /**
   * Increase the verbosity of the output.
   * @environment SHOPIFY_FLAG_VERBOSE
   */
  '--verbose'?: ''
}

Was this section helpful?

App generate extension

shopify app generate extension [flags]

app generate extensioncommand

Anchor to flagsFlags

appgenerateextension

examples

app generate extension

app generate extension

app generate extension
command