{"id":47728,"library":"gatsby-plugin-altair-graphql","title":"Gatsby Altair GraphQL Plugin","description":"A Gatsby plugin that integrates Altair GraphQL client, a feature-rich GraphQL IDE, into your Gatsby site. Current stable version: 8.5.7. Updated as part of the Altair monorepo (releases ~monthly). Key differentiators: easy setup to embed Altair for development/testing, supports GraphQL introspection and schema download. Best for Gatsby developers needing an in-browser GraphQL explorer.","status":"active","version":"8.5.7","language":"javascript","source_language":"en","source_url":"https://github.com/altair-graphql/altair","tags":["javascript","altair","gatsby","gatsby-plugin","graphql"],"install":[{"cmd":"npm install gatsby-plugin-altair-graphql","lang":"bash","label":"npm"},{"cmd":"yarn add gatsby-plugin-altair-graphql","lang":"bash","label":"yarn"},{"cmd":"pnpm add gatsby-plugin-altair-graphql","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Core Altair functionality","package":"altair-graphql-core","optional":false},{"reason":"Peer dependency for Gatsby plugins","package":"gatsby","optional":true}],"imports":[{"note":"CJS-only; Gatsby plugin system expects module.exports, not ESM.","wrong":"import gatsbyPluginAltair from 'gatsby-plugin-altair-graphql'","symbol":"default","correct":"module.exports = require('gatsby-plugin-altair-graphql')"}],"quickstart":{"code":"// gatsby-config.js\nmodule.exports = {\n  plugins: [\n    {\n      resolve: 'gatsby-plugin-altair-graphql',\n      options: {\n        endpointURL: process.env.GATSBY_GRAPHQL_ENDPOINT || 'http://localhost:8000/___graphql',\n        altairDir: '__altair',\n        pageTitle: 'Altair GraphQL',\n      },\n    },\n  ],\n};","lang":"javascript","description":"Configures the plugin in gatsby-config.js with optional endpoint and page path."},"warnings":[{"fix":"Add to plugins array in gatsby-config.js as shown in quickstart.","message":"Must be added as a Gatsby plugin in gatsby-config.js, not imported in pages.","severity":"gotcha","affected_versions":"all"},{"fix":"Use CJS require in gatsby-config.js.","message":"Plugin does not support ESM imports; use require() only.","severity":"breaking","affected_versions":"all"},{"fix":"Explicitly set altairDir option to avoid path conflicts.","message":"altairDir option default '/altair' deprecated in v5+; use '__altair' or custom.","severity":"deprecated","affected_versions":">=5.0.0"}],"env_vars":null,"search_vec":"'8.5.7':26 'altair':2,10,32,42,63 'best':51 'browser':59 'client':12 'current':23 'develop':54 'development/testing':44 'differenti':37 'download':50 'easi':38 'emb':41 'explor':61 'featur':15 'feature-rich':14 'gatsbi':1,6,21,53,64,66 'gatsby-plugin':65 'graphql':3,11,17,46,60,68 'ide':18 'in-brows':57 'integr':9 'introspect':47 'javascript':62 'key':36 'monorepo':33 'month':35 'need':55 'part':29 'plugin':4,7,67 'releas':34 'rich':16 'schema':49 'setup':39 'site':22 'stabl':24 'support':45 'updat':27 'version':25","created_at":"2026-06-07T16:53:00.263752+00:00","updated_at":"2026-06-07T16:53:00.263752+00:00","problems":[{"fix":"npm install gatsby-plugin-altair-graphql@latest","cause":"Package not installed or mismatched version.","error":"Cannot find module 'gatsby-plugin-altair-graphql'"},{"fix":"Ensure options are passed as an object in gatsby-config.js.","cause":"Options object missing when plugin resolves.","error":"Cannot read property 'endpointURL' of undefined"},{"fix":"Check compatibility: npm view gatsby-plugin-altair-graphql peerDependencies","cause":"Gatsby version mismatch (e.g., Gatsby 4 vs 5).","error":"Error: Gatsby plugin gatsby-plugin-altair-graphql is not compatible with your Gatsby version."}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/altair-graphql/altair#readme","github":"https://github.com/altair-graphql/altair","docs":null,"changelog":null,"pypi":null,"npm":"gatsby-plugin-altair-graphql","openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-07","next_check":"2026-09-05","install_tag":null}}