Quick Start

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

📋 Prerequisites

Required: Node.js 14.x or higher (16.x+ recommended), npm or yarn
Optional: Git (needed for Git hooks feature)
Optional: AI tools (Cursor, VS Code, Aider, etc.) - auto-detected during install

1Install ContextKit

Install globally to use it across all your projects:

Global install (recommended)

npm install -g @nolrm/contextkit

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

2Install in Your Project

Navigate to your project directory and run install:

In your terminal

cd your-projectcontextkit install

This creates the .contextkit/ directory with skeleton standards files (blank templates). ContextKit auto-detects your project type and AI tools. After install, run ck analyze to generate content for these files.

💡 Multi-Team Workflow

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

contextkit cursorcontextkit vscodecontextkit claudecontextkit geminicontextkit aidercontextkit continue

3Customize for Your Project

Run analyze to customize standards to your tech stack:

Analyze project

contextkit 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, ck 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. Try: Create checkout flow for customer

Use in VS Code

In Copilot Chat: @.contextkit Create checkout flow for customer

Customize Standards

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

Check Status

Run contextkit status to see detected AI tools.

What Gets Created?

ContextKit creates a .contextkit/ directory with standards, templates, and commands. Auto-detects your AI tools (Cursor, VS Code, Aider, etc.) and configures integrations automatically.

View Platform Examples Learn About Project Structure

Was this helpful?

Help us improve the documentation by sharing your feedback.