app deploy
command

Builds the app, then deploys your app configuration and extensions.

This command creates an app version, which is a snapshot of your app configuration and all extensions, including the app extensions that you manage in the Partner Dashboard. This version is then released to users.

This command doesn't deploy your web app. You need to deploy your web app to your own hosting solution.

Anchor to flagsFlags

The following flags are available for the app deploy command:

Anchor to --client-id <value> --client-id <value> string env: SHOPIFY_FLAG_CLIENT_ID: The Client ID of your app.
Anchor to --message <value> --message <value> string env: SHOPIFY_FLAG_MESSAGE: Optional message that will be associated with this version. This is for internal use only and won't be available externally.
Anchor to --no-build --no-build env: SHOPIFY_FLAG_NO_BUILD: Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running shopify app build or by caching build artifacts.
Anchor to --no-color --no-color env: SHOPIFY_FLAG_NO_COLOR: Disable color output.
Anchor to --no-release --no-release env: SHOPIFY_FLAG_NO_RELEASE: Creates a version but doesn't release it - it's not made available to merchants.
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 --source-control-url <value> --source-control-url <value> string env: SHOPIFY_FLAG_SOURCE_CONTROL_URL: URL associated with the new app version.
Anchor to --verbose --verbose env: SHOPIFY_FLAG_VERBOSE: Increase the verbosity of the output.
Anchor to --version <value> --version <value> string env: SHOPIFY_FLAG_VERSION: Optional version tag that will be associated with this app version. If not provided, an auto-generated identifier will be generated for this app version.
Anchor to -c, --config <value> -c, --config <value> string env: SHOPIFY_FLAG_APP_CONFIG: The name of the app configuration.
Anchor to -f, --force -f, --force env: SHOPIFY_FLAG_FORCE: Deploy without asking for confirmation.

appdeploy

--client-id <value>
The Client ID of your app.
```
string
```
--message <value>
Optional message that will be associated with this version. This is for internal use only and won't be available externally.
```
string
```
--no-build
Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running `shopify app build` or by caching build artifacts.
```
""
```
--no-color
Disable color output.
```
""
```
--no-release
Creates a version but doesn't release it - it's not made available to merchants.
```
""
```
--path <value>
The path to your app directory.
```
string
```
--reset
Reset all your settings.
```
""
```
--source-control-url <value>
URL associated with the new app version.
```
string
```
--verbose
Increase the verbosity of the output.
```
""
```
--version <value>
Optional version tag that will be associated with this app version. If not provided, an auto-generated identifier will be generated for this app version.
```
string
```
-c, --config <value>
The name of the app configuration.
```
string
```
-f, --force
Deploy without asking for confirmation.
```
""
```

export interface appdeploy {
  /**
   * 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

  /**
   * Deploy without asking for confirmation.
   * @environment SHOPIFY_FLAG_FORCE
   */
  '-f, --force'?: ''

  /**
   * Optional message that will be associated with this version. This is for internal use only and won't be available externally.
   * @environment SHOPIFY_FLAG_MESSAGE
   */
  '--message <value>'?: string

  /**
   * Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running `shopify app build` or by caching build artifacts.
   * @environment SHOPIFY_FLAG_NO_BUILD
   */
  '--no-build'?: ''

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

  /**
   * Creates a version but doesn't release it - it's not made available to merchants.
   * @environment SHOPIFY_FLAG_NO_RELEASE
   */
  '--no-release'?: ''

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

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

  /**
   * URL associated with the new app version.
   * @environment SHOPIFY_FLAG_SOURCE_CONTROL_URL
   */
  '--source-control-url <value>'?: string

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

  /**
   * Optional version tag that will be associated with this app version. If not provided, an auto-generated identifier will be generated for this app version.
   * @environment SHOPIFY_FLAG_VERSION
   */
  '--version <value>'?: string
}

Was this section helpful?

App deploy

shopify app deploy [flags]

app deploycommand

Anchor to flagsFlags

appdeploy

examples

app deploy

app deploy

app deploy
command