Shopify CLI commands for apps

Shopify CLI commands should only be run in a project where Shopify CLI is installed.

You can run all Shopify CLI commands using the run command:

You can also run some commands as scripts, which use an abbreviated syntax:

Some package managers require a separator to pass flags to the script:

Builds the app and lets you preview it on a development store or Plus sandbox store.

To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps. If you've run dev before, then your settings are saved and some of these steps are skipped:

• Associating your project with an app associated with your Partner account or organization, or creating a new app.
• Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's selected automatically.
• Installing your app on the store using the provided install link.

• Creating a tunnel between your local environment and the store using Cloudflare.

  You can use your own tunneling software instead, by passing your tunnel URL with the --tunnel-url flag.

• Updating the app URLs that are set in the Partner Dashboard.

  To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.

• Enabling development store preview for extensions.

• Building and serving your app and app extensions.

If you're using the PHP or Ruby app template, then you need to complete the following steps before you can preview your app for the first time:

• PHP: Set up your Laravel app
• Ruby: Set up your Rails app

Displays information about your app.

The information returned includes the following:

• The app and development store or Plus sandbox store that's used when you run the dev command. You can reset these configurations using dev --reset.
• The structure of your app project.
• The access scopes your app has requested.
• System information, including the package manager and version of Shopify CLI used in the project.

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.

Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.

Runs the function from your current directory for testing purposes. To learn how you can monitor and debug functions when errors occur, refer to Shopify Functions error handling.

Generates the latest GraphQL schema for a function in your app. Run this command from the function directory.

This command uses the API type and version of your function, as defined in your extension TOML file, to generate the latest GraphQL schema. The schema is written to the schema.graphql file.

Creates GraphQL types based on your input query for a function written in JavaScript.

Pulls app configuration from the Partner Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.

This command presents you with a prompt with the following steps:

• Which Partner organization is this work for?
  • This prompt shows only if the account you are logged into has more than one organization.
• Create this project as a new app on Shopify?
  • Choosing yes will create a new app in your Partner Dashboard with the default configuration
  • Choosing no will prompt you to choose from a list of all the apps in your organization
• Configuration file name
  • Enter the name for this configuration file. The shopify.app.{config-name}.toml file will be created. If it already exists, you will be prompted to confirm overwriting.

For more information on the format of the created TOML configuration file, refer to the App configuration page.

Sets default configuration when you run app-related CLI commands. If you omit the config-name parameter, then you'll be prompted to choose from the configuration files in your project.

Pushes your default app configuration to Shopify. You can specify a different configuration file with the --config flag. This overwrites the settings for the app specified in the configuration file in your Partner Dashboard.

Builds the app, including extensions.

This command executes the build script specified in the element's TOML file. You can specify a custom script in the file. To learn about configuration files in Shopify apps, refer to App configuration.

If you're building a theme app extension, then running the build command runs Theme Check against your extension to ensure that it's valid.

Builds the app and deploys app extensions.

When you run this command, Shopify CLI creates an app version that contains a snapshot of all of your app extensions, including the app extensions that you manage in the Partner Dashboard, and releases the app version to users.

This command doesn't deploy your web app. When you're ready to deploy your app, you need to deploy these components to your own hosting solution. Learn more about deploying your web app.

Releases an existing app version. Pass the name of the version that you want to release using the --version flag.

Lists the deployed app versions. An app version is a snapshot of your app extensions.

Creates or updates an .env files that contains app and app extension environment variables.

When an existing .env file is updated, changes to the variables are displayed in the terminal output. Existing variables and commented variables are preserved.

Displays environment variables that can be used to deploy apps and app extensions.

Updates the app URL and allowed redirection URLs for your app. When you specify URLs using this command, the current URLs are overwritten.

Your current app URLs are provided as placeholder responses. To keep either your app URL or redirect URLs the same, submit the placeholder content. Alternatively, use the --app-url or --redirect-urls flag to update only one of these settings.

Enables or disables command autocorrection. By default, autocorrect is off.

When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.

When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.

Logs you out of the Shopify account or Partner account and store.

Triggers the delivery of a sample Admin API event topic payload to a designated address.

You should use this command to experiment with webhooks, to initially test your webhook configuration, or for unit testing. However, to test your webhook configuration from end to end, you should always trigger webhooks by performing the related action in Shopify.

Because most webhook deliveries use remote endpoints, you can trigger the command from any directory where you can use Shopify CLI, and send the webhook to any of the supported endpoint types. For example, you can run the command from your app's local directory, but send the webhook to a staging environment endpoint.

To learn more about using webhooks in a Shopify app, refer to Webhooks overview.

• Webhooks triggered using this method always have the same payload, so they can't be used to test scenarios that differ based on the payload contents.
• Webhooks triggered using this method aren't retried when they fail.
• Trigger requests are rate-limited using the Partner API rate limit.
• You can't use this method to validate your API webhook subscriptions.

Lists the available commands and describes what they do.

You can add a help flag to any command to learn more about it. Use --help or -h.

Lists the version of Shopify CLI included in the project.

If nothing is returned from this command, then your project isn't using Shopify CLI 3.0 or higher, and you might need to migrate.

Shopify CLI acts as a dependency of your app. This command upgrades the @shopify/cli and @shopify/app dependencies to their latest versions.

Starts a search on Shopify.dev.

Search the Shopify.dev docs by optionally passing a query argument to the command.