Skip to content
GraphQL Analyzer

Quick Start

1. Install the VS Code extension

Section titled “1. Install the VS Code extension”

Install GraphQL Analyzer from the VS Code Marketplace, or Open VSX for VS Codium/Cursor.

2. Configure your project

Section titled “2. Configure your project”

Create a .graphqlrc.yml (or .graphqlrc.toml) in your project root:

schema: "schema.graphql"
documents: "src/**/*.{graphql,ts,tsx,vue,svelte,astro}"

3. Start coding

Section titled “3. Start coding”

Open any GraphQL file, TypeScript/JavaScript file, or Vue/Svelte/Astro component with embedded GraphQL. You’ll get:

  • Real-time validation — Instant feedback on errors
  • Go to definition — Jump to types, fragments, and fields
  • Find references — See all usages across your project
  • Hover information — Type details and descriptions

4. Add linting (optional)

Section titled “4. Add linting (optional)”

Add lint rules to your configuration:

schema: "schema.graphql"
documents: "src/**/*.{graphql,ts,tsx,vue,svelte,astro}"


extensions:
  graphql-analyzer:
    lint:
      extends: recommended

The recommended preset enables rules that are objectively beneficial without being opinionated. See Linting Overview for details.

5. Set up CI (optional)

Section titled “5. Set up CI (optional)”

Install the CLI and run checks in your pipeline:

Terminal window
curl -fsSL https://raw.githubusercontent.com/trevor-scheer/graphql-analyzer/main/scripts/install.sh | sh
graphql check --format github

See CI/CD Integration for full examples.

Next steps

Section titled “Next steps”