Shopify CLI Docs

shopify app function schema

Fetch the latest GraphQL schema for a function.

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.

Usage

shopify app function schema [flags]

Summary

Fetch the latest GraphQL schema for a function.

Flags

  • --client-id <value> string — The Client ID of your app. optional Environment: SHOPIFY_FLAG_CLIENT_ID.
  • --no-color — Disable color output. optional Environment: SHOPIFY_FLAG_NO_COLOR.
  • --path <value> string — The path to your function directory. optional Environment: SHOPIFY_FLAG_PATH.
  • --reset — Reset all your settings. optional Environment: SHOPIFY_FLAG_RESET.
  • --stdout — Output the schema to stdout instead of writing to a file. optional Environment: SHOPIFY_FLAG_STDOUT.
  • --verbose — Increase the verbosity of the output. optional Environment: SHOPIFY_FLAG_VERBOSE.
  • -c, --config <value> string — The name of the app configuration. optional Environment: SHOPIFY_FLAG_APP_CONFIG.

Official source

On this page