Skip to main content

app build

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.

The following flags are available for the app build command:

Anchor to --client-id <value>
--client-id <value>
string
env: SHOPIFY_FLAG_CLIENT_ID

The Client ID of your app.

Anchor to --no-color
--no-color
env: SHOPIFY_FLAG_NO_COLOR

Disable color output.

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 --skip-dependencies-installation
--skip-dependencies-installation
env: SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION

Skips the installation of dependencies. Deprecated, use workspaces instead.

Anchor to --verbose
--verbose
env: SHOPIFY_FLAG_VERBOSE

Increase the verbosity of the output.

Anchor to -c, --config <value>
-c, --config <value>
string
env: SHOPIFY_FLAG_APP_CONFIG

The name of the app configuration.

Examples

app build

shopify app build [flags]
Was this page helpful?