Quick Start

Get started with ContextKit in 3 simple steps: install the CLI, install in your project, then let your AI tool write the standards with /ck setup.

📋 Prerequisites

✓
Node.js 18.x or higherRequired for running the CLI tools.
✓
Git (Optional)Needed if you plan to use git hooks features.
✓
AI ToolsClaude Code, Codex, Cursor, Copilot, Gemini, OpenCode, Aider, Continue, or Windsurf — selected during installation.

Already using ContextKit 1.x?

Run ck update, then /ck update in your AI tool. The upgrade guide covers what changed and what was removed.

Upgrading to 2.0

1Install ContextKit

Install the CLI globally (one-time setup). Your standards live in each project, not on your machine.

Install the CLI (one-time)

npm install -g @nolrm/contextkit

Or use without installing: npx @nolrm/contextkit@latest install

2Install in Your Project

Navigate to your project directory and initialize ContextKit. This creates the .contextkit/ directory.

In your terminal

cd your-projectcontextkit install

Or specify your AI tool directly: contextkit install claude

What install writes

AGENTS.md — the canonical context file every tool reads (CLAUDE.md imports it)
.contextkit/standards/ — topic standards plus a short always-loaded index.md
Path-scoped rules for your tool, rendered from context_rules in .contextkit/config.yml
Five skills: /ck, /doc, /learn, and the /goal and /headline add-ons
Pre-push and commit-msg quality-gate hooks

Install also writes the always-on headline response-style block. Skip it with contextkit install --no-headline.

💡 Multi-Team Workflow

If .contextkit already exists, add your specific AI tool:

contextkit cursorcontextkit vscodecontextkit claudecontextkit geminicontextkit codexcontextkit opencodecontextkit aidercontextkit continuecontextkit copilotcontextkit windsurf

3Customize for Your Project

Run /ck setup in your AI tool ($ck setup in Codex) to write standards for your codebase:

In your AI tool (Claude, Cursor, etc.)

/ck setup

🎯 What /ck setup does:

Scans your project structure, dependencies, and existing patterns
Writes topic standards with only what the code can't tell the model
Writes .contextkit/standards/index.md — a short always-loaded index (50 lines or fewer)
Writes context_rules so each topic file loads only where it applies
⚠️ Important: Review and edit the generated content manually

📦 Monorepo Support

For monorepos, the contextkit analyze CLI command detects frontend/backend packages and prompts you to select which to analyze:

Frontend: Analyzes React/Vue/Angular packages
Backend: Analyzes API/server packages
Both: Generates separate standards for frontend and backend

Use --scope frontend or --scope backend for non-interactive mode.

You're Ready to Go!

ContextKit is now configured. Here's what to do next:

Use in Cursor

Cursor automatically loads all context files. Once you've added your terms to glossary.md, try: Create [your-feature] for [your-entity]

Use in VS Code

In Copilot Chat: @.contextkit Create [your-feature] for [your-entity] — after adding your terms to glossary.md

Customize Standards

Edit files in .contextkit/standards/ to match your team's preferences.

Long Tasks with /goal

For multi-step work, run /goal "your idea". See /goal.

Check Status

Run contextkit status to see installed integrations, or /ck in your AI tool for a summary and the next step.

What Gets Created?

ContextKit creates AGENTS.md and a .contextkit/ directory with standards, templates, and commands, plus the files your AI tool reads (for Claude Code: CLAUDE.md, .claude/rules/, and .claude/skills/). Choose your AI tool during install or specify it directly with ck install claude.

View Platform Examples Learn About Project Structure

Introduction

Project Structure

Was this helpful?

Help us improve the documentation by sharing your feedback.