Getting Started

Get up and running with GQLens in a few minutes.

Installation

GQLens works with Cursor, VS Code, Claude, Windsurf, Cline, Continue, OpenCode, Zed, and ChatGPT.

See the full Connect Your Tools guide for one-click install buttons, CLI commands, and config snippets for each tool.

CI Integration

GQLens provides a REST API at api.gqlens.com/v1 for managing sources from CI pipelines. You can create sources, trigger re-indexing, and poll status — all authenticated with organization API keys.

Open Organization settings (click your org in the sidebar, then Manage).
Go to the API keys tab and create a new key.
Store the key as a CI secret (e.g. GQLENS_API_KEY).
Use the API to manage sources and trigger indexing on deploy.

See the full CI / API reference for endpoints, curl examples, and a GitHub Actions workflow.

Next Steps

Once configured, GQLens will automatically discover and index your GraphQL schemas, making them available to your AI coding assistant.