app function run

Runs the function from your current directory for testing purposes. To learn how you can monitor and debug functions when errors occur, refer to Shopify Functions error handling.

The following flags are available for the app function run command:

Anchor to --auth-alias <value> --auth-alias <value> string env: SHOPIFY_FLAG_AUTH_ALIAS: Alias of the Shopify account to use for authentication.
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 function directory.
Anchor to --profile --profile env: SHOPIFY_FLAG_PROFILE: Generate a WebAssembly performance profile for the function run. The profile can be viewed in Speedscope.
Anchor to --reset --reset env: SHOPIFY_FLAG_RESET: Reset all your settings.
Anchor to --verbose --verbose env: SHOPIFY_FLAG_VERBOSE: Increase the verbosity of the output. May include sensitive data.
Anchor to -c, --config <value> -c, --config <value> string env: SHOPIFY_FLAG_APP_CONFIG: The name of the app configuration.
Anchor to -e, --export <value> -e, --export <value> string env: SHOPIFY_FLAG_EXPORT: Name of the WebAssembly export to invoke.
Anchor to -i, --input <value> -i, --input <value> string env: SHOPIFY_FLAG_INPUT: The input JSON to pass to the function. If omitted, standard input is used.
Anchor to -j, --json -j, --json env: SHOPIFY_FLAG_JSON: Output the result as JSON. Automatically disables color output.

Examples

shopify app function run [flags]

Was this page helpful?