Skip to main content

store graphiql

Opens a local GraphiQL interface for the GraphQL Admin API on the specified store using previously stored app authentication.

Run shopify store auth first to create stored auth for the store.

By default, Shopify CLI blocks mutations. Re-run with --allow-mutations if you intend to modify store data.

Use the --port flag to run GraphiQL on a specific local port.

The following flags are available for the store graphiql command:

Anchor to -s, --store <value>
-s, --store <value>
string
required
env: SHOPIFY_FLAG_STORE

The myshopify.com domain of the store.

Anchor to --allow-mutations
--allow-mutations
env: SHOPIFY_FLAG_ALLOW_MUTATIONS

Allow GraphQL mutations to run against the target store.

Anchor to --no-color
--no-color
env: SHOPIFY_FLAG_NO_COLOR

Disable color output.

Anchor to --port <value>
--port <value>
string
env: SHOPIFY_FLAG_PORT

Local port for the GraphiQL server. Must be between 1 and 65535.

Anchor to --verbose
--verbose
env: SHOPIFY_FLAG_VERBOSE

Increase the verbosity of the output.

Anchor to --version <value>
--version <value>
string
env: SHOPIFY_FLAG_VERSION

The API version to use in GraphiQL. Defaults to the latest stable version.

Anchor to -v, --variables <value>
-v, --variables <value>
string
env: SHOPIFY_FLAG_VARIABLES

The values for any GraphQL variables in your query or mutation, in JSON format.


Was this page helpful?