Getting Started and Installation

You can choose one to more of the following ways to use GraphQL Inspector.

GitHub Action

The Command Line Tool provides all the features of GraphQL Inspector and can be installed with a single command:

Install using:

npm i --global @graphql-inspector/cli graphql

We added graphql package as a peer dependency to make sure you have the right version installed.

graphql-inspector --help

Options:

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

Install using:

npm i --global @graphql-inspector/ci

Every command is installable through a package.

Please take a look at “Continuous Integration” chapter.

graphql-inspector --help

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

Install using your favorite package manager:

npm i @graphql-inspector/core

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

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