Skip to main content

Shopify CLI App commands

app build

This command executes the build script specified in the element's TOML file.

app config link

Pulls app configuration from the Dev Dashboard and creates or overwrites a configuration file.

app config use

Sets default configuration when you run app-related CLI commands.

app deploy

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

app dev

Builds and previews your app on a dev store, and watches for changes.

app dev clean

Stop the app preview that was started with shopify app dev.

app env pull

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

app env show

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

app function build

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

app function info

The information returned includes the following: - The function handle - The function name - The function API version - The targeting configuration - The schema path - The WASM path - The function runner path

app function replay

Runs the function from your current directory for testing purposes.

app function run

Runs the function from your current directory for testing purposes.

app function schema

Generates the latest GraphQL schema for a function in your app.

app function typegen

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

app generate extension

Generates a new app extension.

app import-extensions

Import dashboard-managed extensions into your app.

app info

The information returned includes the following: - The app and dev store that's used when you run the dev command.

app init

Create a new app project

app logs

Opens a real-time stream of detailed app logs from the selected app and store.

app logs sources

The output source names can be used with the --source argument of shopify app logs to filter log output.

app release

Releases an existing app version.

app versions list

Lists the deployed app versions.

app webhook trigger

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