Getting Started

GitHub Application

Visit GraphQL Inspector (opens in a new tab) on GitHub Marketplace and complete installation.

Read the "GitHub Application" chapter to see the instructions.

GitHub Action

Visit GraphQL Inspector (opens in a new tab) on GitHub Marketplace and complete installation.

Read the "GitHub Action" chapter to see the instructions.

CLI

Command Line Tool with all the features, installable with a single command:

Install using:

yarn global add @graphql-inspector/cli graphql

Usage

graphql-inspector --help

CLI for CI

Works similar to regular CLI but every feature is pluggable to keep the size as low as possible.

Install using:

yarn global add @graphql-inspector/ci

Commands

Every command is installable through a package.

• diff - @graphql-inspector/diff-command
• validate - @graphql-inspector/validate-command
• coverage - @graphql-inspector/coverage-command
• similar - @graphql-inspector/similar-command
• introspect - @graphql-inspector/introspect-command
• serve - @graphql-inspector/serve-command

Usage

graphql-inspector --help

Programmatic API

GraphQL Inspector comes with a programmatic API, here is how to use the Core package.

Install using your favorite package manager:

yarn add @graphql-inspector/core

Usage

import { diff, validate, coverage, ... } from '@graphql-inspector/core'

Docker

GraphQL Inspector is also available on Docker.

docker run kamilkisiela/graphql-inspector --help

Bind volumes to /app for working with local files, for example:

docker run -v $PWD:/app kamilkisiela/graphql-inspector graphql-inspector diff old.graphql new.graphql

To run commands interactively inside of the container, use the following:

docker run -it kamilkisiela/graphql-inspector