app function replaycommand
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.
Anchor to flagsFlags
The following flags are available for the app function replay 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 function directory.
- Anchor to --reset--resetenv: SHOPIFY_FLAG_RESET
Reset all your settings.
- 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.
- Anchor to -j, --json-j, --jsonenv: SHOPIFY_FLAG_JSON
Output the result as JSON.
- Anchor to -l, --log <value>-l, --log <value>stringenv: SHOPIFY_FLAG_LOG
Specifies a log identifier to replay instead of selecting from a list. The identifier is provided in the output of
shopify app devand is the suffix of the log file name.- Anchor to -w, --watch-w, --watchenv: SHOPIFY_FLAG_WATCH
Re-run the function when the source code changes.
appfunctionreplay
- --client-id <value>
The Client ID of your app.
string - --no-color
Disable color output.
"" - --path <value>
The path to your function directory.
string - --reset
Reset all your settings.
"" - --verbose
Increase the verbosity of the output.
"" - -c, --config <value>
The name of the app configuration.
string - -j, --json
Output the result as JSON.
"" - -l, --log <value>
Specifies a log identifier to replay instead of selecting from a list. The identifier is provided in the output of `shopify app dev` and is the suffix of the log file name.
string - -w, --watch
Re-run the function when the source code changes.
""
export interface appfunctionreplay {
/**
* 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
/**
* Output the result as JSON.
* @environment SHOPIFY_FLAG_JSON
*/
'-j, --json'?: ''
/**
* Specifies a log identifier to replay instead of selecting from a list. The identifier is provided in the output of `shopify app dev` and is the suffix of the log file name.
* @environment SHOPIFY_FLAG_LOG
*/
'-l, --log <value>'?: string
/**
* Disable color output.
* @environment SHOPIFY_FLAG_NO_COLOR
*/
'--no-color'?: ''
/**
* The path to your function directory.
* @environment SHOPIFY_FLAG_PATH
*/
'--path <value>'?: string
/**
* Reset all your settings.
* @environment SHOPIFY_FLAG_RESET
*/
'--reset'?: ''
/**
* Increase the verbosity of the output.
* @environment SHOPIFY_FLAG_VERBOSE
*/
'--verbose'?: ''
/**
* Re-run the function when the source code changes.
* @environment SHOPIFY_FLAG_WATCH
*/
'-w, --watch'?: ''
}App function replay
examples
app function replay
app function replay
shopify app function replay [flags]