Shopify CLI Docs

Shopify CLI for apps

Create, develop, configure, deploy, and debug Shopify apps with Shopify CLI.

Shopify CLI accelerates app development by creating app records, generating extensions, building projects, opening local previews through tunnels, deploying configuration, and streaming app logs.

Create an app

pnpm create @shopify/create-app@latest

You can pass a Shopify app template or a GitHub template URL with the --template flag.

Daily app workflow

shopify app dev
shopify app build
shopify app deploy
shopify app logs

App configuration

Useful commands:

  • shopify app config link pulls configuration from the Developer Dashboard and creates or overwrites a local configuration file.
  • shopify app config pull updates an already linked configuration file.
  • shopify app config use sets the default configuration for app commands.
  • shopify app config validate validates app and extension TOML files against schemas.

Extensions and functions

  • shopify app generate extension creates a new app extension.
  • shopify app function build compiles the function to WebAssembly for testing.
  • shopify app function run and shopify app function replay help test function behavior.
  • shopify app function schema and shopify app function typegen generate GraphQL schema/types.

CI/CD

For regular app configuration and extension deployments, integrate shopify app deploy into CI. See CI/CD guide.

On this page