app graphiql
Opens a local GraphiQL interface for the GraphQL Admin API using your app's authentication.
The app must be installed on the store. If you don't specify a store, then Shopify CLI prompts you to select one.
Use the --port flag to run GraphiQL on a specific local port.
Anchor to flagsFlags
The following flags are available for the app graphiql command:
- Anchor to --client-id <value>--client-id <value>--client-id <value>stringstringenv: SHOPIFY_FLAG_CLIENT_IDenv: SHOPIFY_FLAG_CLIENT_ID
The Client ID of your app.
- Anchor to --no-color--no-color--no-colorenv: SHOPIFY_FLAG_NO_COLORenv: SHOPIFY_FLAG_NO_COLOR
Disable color output.
- Anchor to --path <value>--path <value>--path <value>stringstringenv: SHOPIFY_FLAG_PATHenv: SHOPIFY_FLAG_PATH
The path to your app directory.
- Anchor to --port <value>--port <value>--port <value>stringstringenv: SHOPIFY_FLAG_PORTenv: SHOPIFY_FLAG_PORT
Local port for the GraphiQL server. Must be between 1 and 65535.
- Anchor to --reset--reset--resetenv: SHOPIFY_FLAG_RESETenv: SHOPIFY_FLAG_RESET
Reset all your settings.
- Anchor to --verbose--verbose--verboseenv: SHOPIFY_FLAG_VERBOSEenv: SHOPIFY_FLAG_VERBOSE
Increase the verbosity of the output.
- Anchor to --version <value>--version <value>--version <value>stringstringenv: SHOPIFY_FLAG_VERSIONenv: SHOPIFY_FLAG_VERSION
The API version to use in GraphiQL. Defaults to the latest stable version.
- Anchor to -c, --config <value>-c, --config <value>-c, --config <value>stringstringenv: SHOPIFY_FLAG_APP_CONFIGenv: SHOPIFY_FLAG_APP_CONFIG
The name of the app configuration.
- Anchor to -s, --store <value>-s, --store <value>-s, --store <value>stringstringenv: SHOPIFY_FLAG_STOREenv: SHOPIFY_FLAG_STORE
The myshopify.com domain of the store to open GraphiQL against. The app must be installed on the store. If not specified, you will be prompted to select a store.
- Anchor to -v, --variables <value>-v, --variables <value>-v, --variables <value>stringstringenv: SHOPIFY_FLAG_VARIABLESenv: SHOPIFY_FLAG_VARIABLES
The values for any GraphQL variables in your query or mutation, in JSON format.