app buildcommand
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.
Anchor to flagsFlags
The following flags are available for the app build command:
- Anchor to --client-id <value>--client-id <value>stringenv: SHOPIFY_FLAG_CLIENT_ID
The Client ID of your app.
- Anchor to --no-color--no-colorenv: SHOPIFY_FLAG_NO_COLOR
Disable color output.
- Anchor to --path <value>--path <value>stringenv: SHOPIFY_FLAG_PATH
The path to your app directory.
- Anchor to --reset--resetenv: SHOPIFY_FLAG_RESET
Reset all your settings.
- Anchor to --skip-dependencies-installation--skip-dependencies-installationenv: SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION
Skips the installation of dependencies. Deprecated, use workspaces instead.
- Anchor to --verbose--verboseenv: SHOPIFY_FLAG_VERBOSE
Increase the verbosity of the output.
- Anchor to -c, --config <value>-c, --config <value>stringenv: SHOPIFY_FLAG_APP_CONFIG
The name of the app configuration.
appbuild
- --client-id <value>
The Client ID of your app.
string - --no-color
Disable color output.
"" - --path <value>
The path to your app directory.
string - --reset
Reset all your settings.
"" - --skip-dependencies-installation
Skips the installation of dependencies. Deprecated, use workspaces instead.
"" - --verbose
Increase the verbosity of the output.
"" - -c, --config <value>
The name of the app configuration.
string
export interface appbuild {
/**
* The Client ID of your app.
* @environment SHOPIFY_FLAG_CLIENT_ID
*/
'--client-id <value>'?: string
/**
* The name of the app configuration.
* @environment SHOPIFY_FLAG_APP_CONFIG
*/
'-c, --config <value>'?: string
/**
* Disable color output.
* @environment SHOPIFY_FLAG_NO_COLOR
*/
'--no-color'?: ''
/**
* The path to your app directory.
* @environment SHOPIFY_FLAG_PATH
*/
'--path <value>'?: string
/**
* Reset all your settings.
* @environment SHOPIFY_FLAG_RESET
*/
'--reset'?: ''
/**
* Skips the installation of dependencies. Deprecated, use workspaces instead.
* @environment SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION
*/
'--skip-dependencies-installation'?: ''
/**
* Increase the verbosity of the output.
* @environment SHOPIFY_FLAG_VERBOSE
*/
'--verbose'?: ''
}App build
examples
app build
app build
shopify app build [flags]