CK
GitHub

Platform Examples

Step-by-step examples for using ContextKit with Claude Code, Codex, Cursor, Copilot, Gemini CLI, OpenCode, Aider, Continue, and Windsurf. Every integration writes the same canonical AGENTS.md; each tool then imports it, reads it directly, or gets a copy of the same body.

Cursor

Automatic context loading

✅ Zero Configuration Required

.cursor/rules/contextkit-standards.mdc (alwaysApply: true) points Cursor at AGENTS.md and index.md. Topic standards load from path-scoped contextkit-<name>.mdc rules (globs:) only when you touch matching files.

Setup

If .contextkit exists, run contextkit cursor to add Cursor integration. It writes the rules above plus the five skills to .cursor/prompts/ and .agents/skills/.

Basic Usage

In Cursor AI chat
Create a login button using btn pattern

Skills

In Cursor AI chat
/ck setup
  • /doc — update docs affected by this branch
  • /learn — turn a correction into a rule
  • /goal — run a long task against a goal file

VS Code + GitHub Copilot

copilot-instructions.md + path-scoped instructions

Setup

If .contextkit exists, run contextkit copilot (or contextkit vscode). It writes .github/copilot-instructions.md with the same body as AGENTS.md, plus path-scoped .github/instructions/contextkit-<name>.instructions.md files (applyTo:) rendered from context_rules.

Extra context: Mention the Folder

In Copilot Chat
@.contextkit Create a login button

Usually not needed — copilot-instructions.md is loaded automatically. Useful when you want every standards file in one prompt.

Alternative: Mention Subfolders

@.contextkit/standards Create a login button

Standards only (no templates)

@.contextkit/standards/glossary.md @.contextkit/standards/code-style.md Create a login button

Specific files

Claude Code

CLAUDE.md imports AGENTS.md

Auto-Loaded Context

CLAUDE.md imports AGENTS.md and .contextkit/standards/index.md every session. Topic standards load from path-scoped .claude/rules/ files only when you touch matching files.

Setup

Run contextkit claude to set up Claude integration. This writes AGENTS.md, a CLAUDE.md that imports it, path-scoped .claude/rules/, and the five skills in .claude/skills/.

What CLAUDE.md contains

In CLAUDE.md
@AGENTS.md
@.contextkit/standards/index.md

Claude Code: skills run as /ck, /doc, /learn, /goal, /headline. ...

Claude Code reads AGENTS.md on its own only when there is no CLAUDE.md — the import keeps one source of truth.

Path-scoped rules

  • Source: context_rules in .contextkit/config.yml
  • Output: .claude/rules/contextkit-<name>.md with paths: frontmatter
  • Fixed in 2.0: older rule files used globs:, which Claude Code ignores, so they loaded every session

Verify it works

In Claude Code
/context

Check that AGENTS.md and index.md appear in the loaded context list. First time triggers an approval dialog for @imports. Run ck check --context to flag stale references or an oversized always-loaded context.

Usage

Terminal
claude "create [your-feature] for [your-entity]"

Standards are already loaded — no need to tell Claude to read them.

OpenAI Codex CLI

Reads AGENTS.md, skills as $name

Setup

Run contextkit codex to set up Codex integration. Codex reads AGENTS.md automatically. Skills go to .codex/skills/ and the portable .agents/skills/, and run as $ck, $doc, $learn, $goal, $headline.

Usage

Terminal
codex "create a button component"

OpenCode

Auto-loads AGENTS.md

Setup

Run contextkit opencode to set up OpenCode integration. OpenCode auto-loads AGENTS.md, which points it at index.md and the topic standards.

Usage

Terminal
opencode "create a button component"

Continue.dev

Automatic context loading

Setup

If .contextkit exists, run contextkit continue to add Continue integration. It writes .continue/rules/contextkit-standards.md and .continue/config.yaml.

Usage

In Continue chat
Create a login button using project standards

Aider

CONVENTIONS.md

Setup

If .contextkit exists, run contextkit aider to add Aider integration. It writes CONVENTIONS.md with the same body as AGENTS.md, plus .aider/rules.md.

Usage

Terminal
aider "Create a login button. Follow .contextkit/standards/code-style.md"

Google Gemini CLI

GEMINI.md imports AGENTS.md

Setup

Run contextkit gemini. It writes GEMINI.md — a short pointer plus @AGENTS.md — which Gemini CLI loads automatically.

Usage

Terminal
gemini "create a button component"

Windsurf

Automatic context loading

Setup

If .contextkit exists, run contextkit windsurf to add Windsurf integration. It writes .windsurfrules with the same body as AGENTS.md, plus .windsurf/rules/contextkit-standards.md.

Usage

In Windsurf AI chat
Create a login button using project standards

Windsurf automatically loads all ContextKit rules from .windsurfrules and .windsurf/rules/contextkit-standards.md.

👥 Multi-Team Workflow

Perfect for teams where members use different AI tools. Share the .contextkit/ directory, and each team member adds their specific integration:

Person 1: contextkit install cursor
Person 2 (Cursor): contextkit cursor
Person 3 (VS Code): contextkit vscode
Person 4 (Claude): contextkit claude
Person 5 (Gemini): contextkit gemini
Person 6 (Codex): contextkit codex
Person 7 (OpenCode): contextkit opencode
Person 8 (Windsurf): contextkit windsurf

✨ Choose Your Tool

During ck install, you choose which AI tool to configure — or specify it directly: ck install claude. Run contextkit status to see installed integrations.

Previous
Quality Gates
Next
Monorepo Support

Was this helpful?

Help us improve the documentation by sharing your feedback.