CK
GitHub

Platform Examples

Step-by-step examples for using ContextKit with Cursor, VS Code, Claude CLI, Gemini CLI, Codex CLI, OpenCode, Windsurf, and other AI tools.

Cursor

Automatic context loading

✅ Zero Configuration Required

Cursor automatically loads all ContextKit context files via .cursor/rules/contextkit.mdc for every AI prompt.

Setup

If .contextkit exists, run contextkit cursor to add Cursor integration. Cursor automatically reads your context files via .cursor/rules/contextkit.mdc.

Basic Usage

In Cursor AI chat
Create a login button using btn pattern

Reference Commands

In Cursor AI chat
@.contextkit/commands/analyze.md
  • @.contextkit/commands/create-component.md
  • @.contextkit/commands/run-tests.md
  • @.contextkit/commands/quality-check.md

VS Code + GitHub Copilot

Use @ mentions in chat

Setup

If .contextkit exists, run contextkit vscode to add VS Code integration. Check .vscode/VSCODE_USAGE.md for details.

⭐⭐ Best: Mention Entire Folder

In Copilot Chat
@.contextkit Create a login button

✅ Includes ALL context files (standards, templates, commands) - No slash needed!

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

Auto-loaded standards via @imports

Auto-Loaded Context

CLAUDE.md uses @path imports to auto-load all standards and product files into context every session. No manual file reads needed — saves tokens and ensures consistency.

Setup

Run contextkit claude to set up Claude integration. This generates a CLAUDE.md with @ imports that auto-load your standards, plus .claude/rules/ and .claude/commands/.

How @imports work

In CLAUDE.md
- @.contextkit/standards/code-style.md
- @.contextkit/standards/testing.md
- @.contextkit/product/mission-lite.md

Claude Code resolves these on startup and loads the file contents into context automatically.

Token impact

  • Upfront: Standards content is loaded into base context (slightly larger initial prompt)
  • Per-session: No Read tool calls needed — saves tokens from avoided round-trips
  • Net effect: Fewer total tokens for typical sessions, plus guaranteed consistency

Verify it works

In Claude Code
/context

Check that your standards files appear in the loaded context list. First time triggers an approval dialog for @imports.

Usage

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

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

OpenAI Codex CLI

Direct file references

Setup

Run contextkit codex to set up Codex integration. Codex CLI works by referencing .contextkit files in your prompts.

Usage

Terminal
codex "read .contextkit/context.md and create a button"

OpenCode

Auto-loads AGENTS.md

Setup

Run contextkit opencode to set up OpenCode integration. OpenCode auto-loads AGENTS.md so your standards are always in context.

Usage

Terminal
opencode "create a button component"

Continue.dev

Automatic context loading

Setup

If .contextkit exists, run contextkit continue to add Continue integration. Continue.dev automatically loads context from .continue/config.json.

Usage

In Continue chat
Read .contextkit/commands/analyze.md and execute the analysis

Aider

Direct file references

Setup

If .contextkit exists, run contextkit aider to add Aider integration. The .aider/rules.md file will be configured.

Usage

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

Google Gemini CLI

Direct file references

Setup

If .contextkit exists, use it directly. Gemini CLI works by referencing .contextkit files in your prompts.

Usage

Terminal
gemini "read .contextkit/context.md and create a button"

Windsurf

Automatic context loading

Setup

If .contextkit exists, run contextkit windsurf to add Windsurf integration. Windsurf automatically reads .windsurfrules and .windsurf/rules/.

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.