Coding Agents

gqlkit provides built-in support for AI coding agents like Claude Code and OpenAI Codex . The gqlkit docs command generates skill files that help these tools understand gqlkit conventions and provide better assistance.

Setup

Run the following command in your project root:


npm exec gqlkit docs


pnpm gqlkit docs


yarn gqlkit docs

The command auto-detects your environment based on existing files (CLAUDE.md, .claude/, AGENTS.md, .codex/) and generates the appropriate files.

Generated Files

Claude Code

When Claude Code environment is detected (or --claude flag is used):

.claude/skills/gqlkit-guide/SKILL.md - Skill definition with gqlkit documentation
.claude/skills/gqlkit-guide/references/ - Symlink to detailed documentation
CLAUDE.md - Updated with gqlkit section (created if not exists)

OpenAI Codex

When Codex environment is detected (or --codex flag is used):

.codex/skills/gqlkit-guide/SKILL.md - Skill definition with gqlkit documentation
.codex/skills/gqlkit-guide/references/ - Symlink to detailed documentation
AGENTS.md - Updated with gqlkit section (created if not exists)

Options

Option	Description
`--output <dir>`	Output directory (default: current directory)
`--claude`	Generate Claude Code files explicitly
`--codex`	Generate Codex files explicitly

How It Works

The generated skill files follow the Agent Skills specification. When you ask the coding agent about gqlkit, it will:

Recognize gqlkit-related questions from the skill description
Read the bundled documentation to understand gqlkit conventions
Provide accurate guidance based on the latest documentation

Keeping Skills Updated

Re-run gqlkit docs after updating gqlkit to ensure the skill files reflect the latest documentation.