app function schemacommand
Generates the latest GraphQL schema for a function in your app. Run this command from the function directory.
This command uses the API type and version of your function, as defined in your extension TOML file, to generate the latest GraphQL schema. The schema is written to the schema.graphql file.
Anchor to flagsFlags
The following flags are available for the app function schema 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 --stdout--stdoutenv: SHOPIFY_FLAG_STDOUT
Output the schema to stdout instead of writing to a file.
- 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.
appfunctionschema
- --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.
"" - --stdout
Output the schema to stdout instead of writing to a file.
"" - --verbose
Increase the verbosity of the output.
"" - -c, --config <value>
The name of the app configuration.
string
export interface appfunctionschema {
/**
* 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 function directory.
* @environment SHOPIFY_FLAG_PATH
*/
'--path <value>'?: string
/**
* Reset all your settings.
* @environment SHOPIFY_FLAG_RESET
*/
'--reset'?: ''
/**
* Output the schema to stdout instead of writing to a file.
* @environment SHOPIFY_FLAG_STDOUT
*/
'--stdout'?: ''
/**
* Increase the verbosity of the output.
* @environment SHOPIFY_FLAG_VERBOSE
*/
'--verbose'?: ''
}App function schema
examples
app function schema
app function schema
shopify app function schema [flags]