Quick Start

Get started with ContextKit in 3 simple steps. This guide walks you through installation, setup, and your first use.

📋 Prerequisites

✓
Node.js 18.x or higherRequired for running the CLI tools.
✓
Git (Optional)Needed if you plan to use git hooks features.
✓
AI ToolsCursor, VS Code, or Aider - selected during installation.

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

💡 Multi-Team Workflow

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

contextkit cursorcontextkit vscodecontextkit claudecontextkit geminicontextkit codexcontextkit opencodecontextkit aidercontextkit continue

3Customize for Your Project

Run /analyze in your AI tool to customize standards to your tech stack:

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

/analyze

🎯 What analyze does:

Scans your project structure and dependencies
Detects existing patterns and configurations
Generates standards content based on your actual codebase
Creates project-specific AI guidelines
⚠️ Important: Review and edit the generated content manually

📦 Monorepo Support

For monorepos, /analyze automatically 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.

Check Status

Run contextkit status to see installed integrations.

What Gets Created?

ContextKit creates a .contextkit/ directory with standards, templates, and commands. Choose your AI tool during install or specify it directly with ck install claude. For Claude Code installs, .claude/settings.json is also created with a PostToolUse hook that runs format+lint after every file edit.

View Platform Examples Learn About Project Structure

Introduction

Project Structure

Was this helpful?

Help us improve the documentation by sharing your feedback.