app logscommand
Opens a real-time stream of detailed app logs from the selected app and store.
Use the --source
argument to limit output to a particular log source, such as a specific Shopify Function handle. Use the shopify app logs sources
command to view a list of sources.
Use the --status
argument to filter on status, either success
or failure
.
shopify app logs --status=success --source=extension.discount-function
Anchor to flagsFlags
The following flags are available for the app logs
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 --source <value>--source <value>stringenv: SHOPIFY_FLAG_SOURCE
Filters output to the specified log source.
- Anchor to --status <value>--status <value>stringenv: SHOPIFY_FLAG_STATUS
Filters output to the specified status (success or failure).
- 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 -s, --store <value>-s, --store <value>stringenv: SHOPIFY_FLAG_STORE
Store URL. Must be an existing development or Shopify Plus sandbox store.
applogs
- --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.
""
- --source <value>
Filters output to the specified log source.
string
- --status <value>
Filters output to the specified status (success or failure).
string
- --verbose
Increase the verbosity of the output.
""
- -c, --config <value>
The name of the app configuration.
string
- -j, --json
Output the result as JSON.
""
- -s, --store <value>
Store URL. Must be an existing development or Shopify Plus sandbox store.
string
export interface applogs {
/**
* 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'?: ''
/**
* 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'?: ''
/**
* Filters output to the specified log source.
* @environment SHOPIFY_FLAG_SOURCE
*/
'--source <value>'?: string
/**
* Filters output to the specified status (success or failure).
* @environment SHOPIFY_FLAG_STATUS
*/
'--status <value>'?: string
/**
* Store URL. Must be an existing development or Shopify Plus sandbox store.
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
/**
* Increase the verbosity of the output.
* @environment SHOPIFY_FLAG_VERBOSE
*/
'--verbose'?: ''
}
App logs
examples
app logs
app logs
shopify app logs [flags]