# GraphQL Inspector

> Tools to compare GraphQL schemas and detect breaking changes, validate operations and fragments, measure schema coverage, and get schema change notifications, as a CLI, a GitHub Action, and a programmatic API.

## Documentation

- [GraphQL Inspector](https://the-guild.dev/graphql/inspector/docs.md): GraphQL Inspector is a set of tools to help you better maintain and improve GraphQL API as well as GraphQL consumers.
- [Getting Started and Installation](https://the-guild.dev/graphql/inspector/docs/installation.md): Install GraphQL Inspector as a CLI, a GitHub Action, or a programmatic API, and run your first schema check.
- [Diff](https://the-guild.dev/graphql/inspector/docs/commands/diff.md): Detect changes to your GraphQL Schema and prevent breaking your existing applications. With GraphQL Inspector you get a list of breaking, potentially dangerous and safe changes on every Pull Request.
- [Coverage](https://the-guild.dev/graphql/inspector/docs/commands/coverage.md): Schema coverage is based on documents. Find out how many times types and fields are used in your application.
- [Audit](https://the-guild.dev/graphql/inspector/docs/commands/audit.md): GraphQL Inspector Audit Documents - Audit your documents for useful metrics such as query depth, directive count and alias count.
- [Introspect](https://the-guild.dev/graphql/inspector/docs/commands/introspect.md): GraphQL Inspector Introspection - Dumps an introspection file based on a schema.
- [Serve](https://the-guild.dev/graphql/inspector/docs/commands/serve.md): Serve a GraphQL schema with faked data - Takes a GraphQL schema and runs a server based on it, with faked data.
- [Similar](https://the-guild.dev/graphql/inspector/docs/commands/similar.md): Find Similar Types - Get a list of similar types to find duplicates.
- [Validate](https://the-guild.dev/graphql/inspector/docs/commands/validate.md): Validate Documents - Validate documents against a schema and looks for deprecated usage.
- [Schema Change Notifications](https://the-guild.dev/graphql/inspector/docs/notifications.md): Stay up to date with changes in your GraphQL Schema. Receive notifications on Slack, Discord or even via WebHooks every time new changes are introduced.
- [Using Environments](https://the-guild.dev/graphql/inspector/docs/recipes/environments.md): In cases where you have multiple environments and not only production, GraphQL Inspector App can help you keep track of them.
- [Using GraphQL Endpoints](https://the-guild.dev/graphql/inspector/docs/recipes/endpoints.md): In this chapter, we're going to use live and running GraphQL API instead of GraphQL file as the source of truth of your schema.
- [Intercepting Schema Changes](https://the-guild.dev/graphql/inspector/docs/recipes/intercept.md): GraphQL Inspector lets you intercept schema changes via HTTP. You're able to decide which changes are acceptable and which are not and all of this through even a serverless function.
- [Annotations](https://the-guild.dev/graphql/inspector/docs/recipes/annotations.md): GitHub offers in-code annotations and GraphQL Inspector, both App and Action enable you to use them.
- [Managing Pull Requests](https://the-guild.dev/graphql/inspector/docs/recipes/pull-requests.md): GraphQL Inspector runs a change detection on every Pull Request. It matches the target branch with the one defined in the Inspector configuration.
- [Continuous Integration](https://the-guild.dev/graphql/inspector/docs/products/ci.md): GraphQL Inspector can be used with any Continuous Integration. It's easy!
- [GitHub Action](https://the-guild.dev/graphql/inspector/docs/products/action.md): GraphQL Inspector Action checks your Pull Request to find breaking changes (and others) in a GraphQL Schema, against your `master` branch.
- [Providing Schema](https://the-guild.dev/graphql/inspector/docs/api/schema.md): GraphQL Inspector - There are a few options to provide your schema in GraphQL Inspector.
- [Providing Documents](https://the-guild.dev/graphql/inspector/docs/api/documents.md): GraphQL Inspector - There are a few ways of providing operations and fragments (documents in general).
- [From GraphQL-CLI](https://the-guild.dev/graphql/inspector/docs/migration-guides/from-graphql-cli.md): GraphQL-CLI was wrapping the commands implemented in GraphQL-Inspector, in order to provide a unified experience. You can switch to using GraphQL-Inspector directly.
- [GitHub Application - Deprecated](https://the-guild.dev/graphql/inspector/docs/migration-guides/github.md): GraphQL Inspector App is a GitHub Application that you can install in any of your repositories.
- [From GitHub Application to GitHub Action](https://the-guild.dev/graphql/inspector/docs/migration-guides/from-app-to-action.md): Migrate from GraphQL Inspector App to GraphQL Inspector Action for enhanced schema validation.