Skip to main content

app function schema
command

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>
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 --reset
--reset
env: SHOPIFY_FLAG_RESET

Reset all your settings.

Anchor to --stdout
--stdout
env: SHOPIFY_FLAG_STDOUT

Output the schema to stdout instead of writing to a file.

Anchor to --verbose
--verbose
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.

Was this section helpful?

App function schema

shopify app function schema [flags]