Shopify CLI app commands

This reference lists the Shopify CLI commands for apps. The basic syntax for these commands is shopify app <command>.

To get help and tips from the command line, type a command with the flag -h:

create

Creates a project in a new subdirectory of the current directory.

Specify one of the following frameworks in your command after create:

After you enter the command, you're prompted to name your project.

connect

Connects an existing Shopify CLI project to a Partner account or to a specific Shopify development store.

The connect command re-creates the project's .env and .shopify-cli.yml files if they don't exist, or updates the files if they do exist.

  • .env contains sensitive information that provides functionality to your app, such as the app key. As a result, this file shouldn't be saved to a version control system.
  • shopify-cli.yml contains insensitive information required for a project to work with Shopify CLI, such as the project type.

This command is useful if you're working on one project across multiple computers, or if you're collaborating with other developers using a version control system like Git.

deploy

Deploys the current app to a hosting service. Currently, the only option is Heroku.

open

Opens your local development app in your default browser.

serve

Starts a local development server for your project and a public ngrok tunnel to your localhost.

tunnel

Controls an HTTP tunnel to your local development app using ngrok. With the tunnel command, you can authenticate with ngrok and start or stop the tunnel.

To authenticate with ngrok, you need an authentication token from your ngrok dashboard. Copy your token and use it with the auth command:

To learn more about, refer to ngrok’s documentation.

start

Start an ngrok tunnel to your app in your localhost development environment:

stop

Stop the running ngrok tunnel:

Next steps