Skip to main content

introspect

Dumps an introspection file based on a schema. See the official GraphQL Inspector documentation for details.

Installation#

yarn global add @graphql-cli/introspect

Usage#

graphql introspect [SCHEMA]

Arguments#

argumentdescriptiondefault
SCHEMAA pointer to a schemaschema property in GraphQL Config file

Options#

optionaliasdescriptiondefault
--write-wOverwrite the outputgraphql.schema.json
--require-rRequire a module[]
--token-tAn access tokenundefined
--header-hSet HTTP header (--header 'Auth: Basic 123')undefined