Skip to main content

app function run
command

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:

string
env: SHOPIFY_FLAG_CLIENT_ID

The Client ID of your app.

env: SHOPIFY_FLAG_NO_COLOR

Disable color output.

string
env: SHOPIFY_FLAG_PATH

The path to your function directory.

env: SHOPIFY_FLAG_RESET

Reset all your settings.

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.

Anchor to -e, --export <value>
-e, --export <value>
string
env: SHOPIFY_FLAG_EXPORT

Name of the WebAssembly export to invoke.

string
env: SHOPIFY_FLAG_INPUT

The input JSON to pass to the function. If omitted, standard input is used.

env: SHOPIFY_FLAG_JSON

Output the result as JSON.

Was this section helpful?

App function run

shopify app function run [flags]