JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 42
  • Score
    100M100P100Q88378F
  • License MIT

Unified AI Context Engineering - Intelligent context for Claude, Copilot, Cline, and more with OpenRouter-powered initialization

Package Exports

  • k0ntext
  • k0ntext/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (k0ntext) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

K0ntext

npm version npm downloads License: MIT Build Status Node Version MCP Protocol

Universal AI context engineering for Claude, GitHub Copilot, Cline, Cursor, Windsurf, Aider, Continue, Antigravity, and Gemini with OpenRouter-powered intelligent analysis.

Table of Contents

🚀 Quick Start (30 Seconds)

# Install globally
npm install -g k0ntext

# Initialize your project with intelligent analysis
k0ntext init

# Generate context files for all AI tools
k0ntext generate

# Start the MCP server for AI tools
k0ntext mcp

🎯 Zero-to-Hero Workflow

New Project Setup

# 1. Initialize with intelligent analysis
k0ntext init --intelligent

# 2. Index your codebase
k0ntext index

# 3. Generate context files
k0ntext generate

# 4. Start MCP server (auto-configured)
k0ntext mcp

Existing Project Setup

# 1. Check existing context
k0ntext stats

# 2. Index codebase if needed
k0ntext index --docs --code

# 3. Generate missing tool configs
k0ntext generate --force

# 4. Validate everything
k0ntext validate --strict

🖥️ Windows Support

K0ntext uses native SQLite extensions for high-performance vector search.

For Windows Users:

  • Recommended: Use Node.js LTS (v18, v20, v22) with pre-built binaries
  • Instant install: These versions install without extra tools
  • Non-LTS versions (v23/v24): May require Visual Studio Build Tools to compile the database driver

✨ Features Overview

🖥️ Interactive REPL Shell (v3.3.0)

  • Auto-start: Running k0ntext with no arguments launches the interactive shell
  • Session persistence: Command history and statistics saved across sessions
  • Built-in commands: help, stats, index, search, config, drift, init, update, exit
  • Orange gradient theme with Unicode/ASCII fallback and terminal capability detection
  • Update checker with automatic version notifications on startup

🎨 Enhanced TUI Panels (v3.3.1)

  • Advanced Search Panel - Filtered, sortable search with --type, --sort, --limit flags and content previews
  • Configuration UI - Interactive editor with 4 categories (Project, AI Tools, Features, Display)
  • Indexing Progress - Real-time multi-stage progress visualization with ora spinner
  • Drift Detection - Three-axis analysis (file dates, structure, git diff) with severity-coded reporting

🧠 Intelligent Analysis

  • OpenRouter-powered codebase analysis with embeddings
  • Tech stack detection and documentation
  • Workflow discovery and categorization
  • Automatic context generation
  • Centralized model configuration (v3.1.0) - Single source of truth for all AI operations
  • Vector database (sqlite-vec) for intelligent code retrieval
  • Hybrid search (text + semantic)
  • Content type filtering (workflow, agent, command, code, doc, etc.)
  • Real-time indexing with watch mode

🔄 Cross-Tool Sync

  • 9 AI Tools Supported: Claude, Copilot, Cline, Antigravity, Windsurf, Aider, Continue, Cursor, Gemini
  • Automatic synchronization between tool configurations
  • Change detection with SHA256 hashing
  • Sync status monitoring
  • Intelligent cross-sync (v3.1.0) - AI-powered propagation of changes across tools

🤖 Git Hooks Automation (v3.1.0)

  • Pre-commit workflow - Automatic context maintenance
  • Drift detection on every commit
  • Automatic cross-sync when drift detected
  • Updated context files auto-added to commits

🎯 Drift Detection (v3.1.0)

  • AI-powered semantic analysis - Detect when documentation diverges from code
  • Replaces hash-based checks with intelligent understanding
  • Severity-based reporting (high/medium/low)
  • Automatic fix suggestions

📋 Fact-Checking (v3.1.0)

  • Validate documentation accuracy against codebase
  • Identify outdated APIs, wrong file paths, missing dependencies
  • Confidence scoring for each claim

🗺️ Map-Based Context (v3.1.0)

  • Concise, structured context files
  • Reduce hallucination through precise references
  • Alternative to verbose documentation format

🤖 MCP Server

  • Auto-Configuration (v3.1.1) - MCP server automatically configured in .claude/settings.json on init
  • 10 Tools: search_context, get_item, add_knowledge, analyze, get_tool_configs, query_graph, get_stats
  • 6 Prompts: context-engineer, core-architect, api-developer, database-ops, integration-hub, deployment-ops
  • Real-time context access for AI assistants
  • Knowledge graph traversal
  • 10 Tools: search_context, get_item, add_knowledge, analyze, get_tool_configs, query_graph, get_stats
  • 6 Prompts: context-engineer, core-architect, api-developer, database-ops, integration-hub, deployment-ops
  • Real-time context access for AI assistants
  • Knowledge graph traversal

🛠️ Complete CLI (18 Commands)

  • init - Initialize with intelligent analysis (auto-configures MCP in v3.1.1)
  • generate - Generate context files for all tools
  • mcp - Start MCP server
  • sync - Sync across AI tools
  • cleanup - Clean up conflicting tool folders
  • validate - Validate context files
  • export - Export database
  • import - Import from exports
  • performance - Show performance metrics
  • watch - Auto-index file changes
  • index - Index codebase
  • search - Search indexed content
  • stats - View database statistics
  • drift-detect - AI-powered documentation drift detection (v3.1.0)
  • cross-sync - Intelligent sync across all AI tools (v3.1.0)
  • hooks - Git hooks management (install/uninstall/status) (v3.1.0)
  • fact-check - Validate documentation accuracy (v3.1.0)
  • generate --map - Generate concise map-based context files (v3.1.0)
  • CLI documentation in all templates (v3.1.1) - Agent and command templates now include k0ntext CLI usage guidance
  • init - Initialize with intelligent analysis
  • generate - Generate context files for all tools
  • mcp - Start MCP server
  • sync - Sync across AI tools
  • cleanup - Clean up conflicting tool folders
  • validate - Validate context files
  • export - Export database
  • import - Import from exports
  • performance - Show performance metrics
  • watch - Auto-index file changes
  • index - Index codebase
  • search - Search indexed content
  • stats - View database statistics
  • drift-detect - AI-powered documentation drift detection
  • cross-sync - Intelligent sync across all AI tools
  • hooks - Git hooks management (install/uninstall/status)
  • fact-check - Validate documentation accuracy
  • generate --map - Generate concise map-based context files

📊 Smart Agents

  • CleanupAgent - Remove conflicting AI tool folders (.cursor, .windsurf, .cline, etc.)
  • PerformanceMonitorAgent - Track database performance and suggest optimizations
  • DriftAgent (v3.1.0) - AI-powered documentation drift detection
  • FactCheckAgent (v3.1.0) - Validate documentation accuracy against codebase

🗃️ SQLite Storage

  • Persistent database with SHA256 change detection
  • Embeddings support for semantic search
  • Knowledge graph relationships
  • Automatic schema migrations

📖 Complete CLI Reference

Core Commands

k0ntext init [project-name]

Initialize AI context for a project with intelligent analysis.

# Initialize current directory
k0ntext init

# Initialize specific project
k0ntext init my-project

# Skip intelligent analysis (faster)
k0ntext init --no-intelligent

Options:

  • --no-intelligent - Skip OpenRouter-powered analysis
  • -v, --verbose - Show detailed output

k0ntext generate

Generate context files for all AI tools.

# Generate for all tools
k0ntext generate

# Generate for specific tools
k0ntext generate -ai claude,copilot,cursor

# Force regenerate all files
k0ntext generate --force

# Verbose output
k0ntext generate -v

Options:

  • -ai, --ai <tools> - Specific tools (comma-separated)
  • --force - Force regenerate all files
  • --map - Use concise map-based format (new in v3.1.0)
  • -v, --verbose - Show detailed output

k0ntext mcp

Start the Model Context Protocol server.

# Start with default database
k0ntext mcp

# Specify database path
k0ntext mcp --db .my-context.db

Options:

  • --db <path> - Database file path

k0ntext sync

Synchronize context across AI tools.

# Sync all tools
k0ntext sync

# Check sync status only
k0ntext sync --check

# Sync from specific tool
k0ntext sync --from claude

# Sync to specific tool
k0ntext sync --to copilot

# Force sync
k0ntext sync --force

Options:

  • --check - Only check synchronization status
  • --from <tool> - Sync from specific tool
  • --to <tool> - Sync to specific tool
  • --force - Force sync even if up-to-date

k0ntext cleanup

Clean up context folders from other AI tools.

# Dry run to see what would be removed
k0ntext cleanup --dry-run

# Keep specific folders
k0ntext cleanup --keep .github,.vscode

# Verbose output
k0ntext cleanup -v

Options:

  • --dry-run - Show what would be removed
  • --keep <folders> - Folders to keep (comma-separated)
  • --ai - Use AI to intelligently analyze which folders can be safely removed (new in v3.1.0)
  • -v, --verbose - Show detailed output

k0ntext validate

Validate context files and AI tool configurations.

# Basic validation
k0ntext validate

# Auto-fix errors
k0ntext validate --fix

# Treat warnings as errors
k0ntext validate --strict

Options:

  • --fix - Automatically fix validation errors
  • --strict - Treat warnings as errors

k0ntext export <output>

Export context database to file.

# Export as JSON
k0ntext export context.json

# Export as markdown
k0ntext export docs.md --format markdown

# Export specific type
k0ntext export workflows.json --type workflow

Options:

  • --format <format> - Export format (json, markdown)
  • --type <type> - Filter by context type

k0ntext import <input>

Import context data from exported files.

# Import JSON export
k0ntext import context.json

# Import and merge with existing data
k0ntext import context.json --merge

Options:

  • --format <format> - Import format (json, markdown)
  • --merge - Merge with existing data (default: replace)

k0ntext performance

Show performance metrics and optimization suggestions.

# Human-readable report
k0ntext performance

# JSON output
k0ntext performance --json

Options:

  • --json - Output as JSON

k0ntext watch

Watch for file changes and auto-update index.

# Start watching with 1s delay
k0ntext watch

# Custom debounce delay
k0ntext watch -d 2000

Options:

  • -d, --delay <ms> - Debounce delay in milliseconds

k0ntext index

Index codebase content into the database.

# Index everything
k0ntext index

# Index documentation only
k0ntext index --docs

# Index source code only
k0ntext index --code

# Index AI tool configs only
k0ntext index --tools

# Verbose output
k0ntext index -v

Options:

  • --docs - Index documentation files only
  • --code - Index source code only
  • --tools - Index AI tool configurations only
  • --all - Index everything (default)
  • -v, --verbose - Show detailed output

k0ntext search <query>

Search across indexed content.

# Basic search
k0ntext search "authentication"

# Search specific type
k0ntext search "user login" -t workflow

# Text-only search
k0ntext search "API endpoint" -m text

# Semantic search (requires OPENROUTER_API_KEY)
k0ntext search "data persistence" -m semantic

# Limit results
k0ntext search "database" -l 5

Options:

  • -t, --type <type> - Filter by type
  • -l, --limit <n> - Maximum results (default: 10)
  • -m, --mode <mode> - Search mode: text, semantic, hybrid

k0ntext stats

Show database and indexing statistics.

# View all statistics
k0ntext stats

# Show specific stats (filtered by index)
k0ntext stats | grep "Context Items"

v3.1.0 New Commands

k0ntext drift-detect

AI-powered documentation drift detection using semantic analysis.

# Detect drift in all context files
k0ntext drift-detect

# Detect drift in specific paths
k0ntext drift-detect -p CLAUDE.md,.cursorrules

# Check up to 20 files
k0ntext drift-detect --max-files 20

# Strict mode (fails on any drift)
k0ntext drift-detect --strict

# Verbose output
k0ntext drift-detect -v

Options:

  • --fix - Automatically fix detected drift (experimental)
  • --strict - Fail on any drift detected
  • -p, --paths <paths> - Comma-separated paths to check
  • --max-files <number> - Maximum files to check (default: 50)
  • --model <model> - Override model (not recommended)
  • -v, --verbose - Show detailed output

k0ntext cross-sync

Intelligently synchronize context across all AI tools after drift detection.

# Sync all affected files
k0ntext cross-sync

# Dry run to see what would be synced
k0ntext cross-sync --dry-run

# Sync to specific tools only
k0ntext cross-sync --to claude,cursor

# Sync from specific files
k0ntext cross-sync --affected CLAUDE.md,.cursorrules

# Verbose output with details
k0ntext cross-sync -v

Options:

  • --dry-run - Show what would be synced without making changes
  • --from <tool> - Sync only from specific tool
  • --to <tools> - Sync only to specific tools (comma-separated)
  • --affected <files> - Comma-separated list of affected files
  • -v, --verbose - Show detailed sync output

k0ntext hooks

Manage git hooks for automatic context synchronization.

# Install git hooks
k0ntext hooks install

# Install with force (overwrite existing)
k0ntext hooks install -f

# Uninstall git hooks
k0ntext hooks uninstall

# Check hooks status
k0ntext hooks status

Subcommands:

  • install - Install pre-commit hook for automatic workflow
  • uninstall - Remove installed hooks
  • status - Show hook installation status

Install Options:

  • -f, --force - Overwrite existing hooks
  • --skip-backup - Skip backing up existing hooks

k0ntext fact-check [files...]

Validate documentation accuracy using AI analysis.

# Check all documentation files
k0ntext fact-check

# Check specific files
k0ntext fact-check CLAUDE.md .cursorrules

# Set minimum confidence threshold
k0ntext fact-check --min-confidence 0.7

# Verbose output
k0ntext fact-check -v

Options:

  • --fix - Automatically fix detected issues (experimental)
  • -v, --verbose - Show detailed output
  • --min-confidence <number> - Minimum confidence to report (0-1, default: 0.5)

Git Hooks Workflow (v3.1.0)

When you install hooks with k0ntext hooks install, the pre-commit hook automatically:

  1. Autosync - Sync context from source of truth
  2. Validate - Check for context errors
  3. Drift Detect - AI-powered drift detection
  4. Cross-Sync - Update all AI tool contexts if drift found
  5. Auto-Add - Include updated context files in commit

Skip hooks temporarily:

K0NTEXT_SKIP_HOOKS=1 git commit -m "message"
# or
git commit --no-verify -m "message"

🤖 MCP Server Usage

Auto-Configuration (v3.1.1)

When you run k0ntext init, the MCP server is automatically configured in .claude/settings.json:

{
  "mcpServers": {
    "k0ntext": {
      "command": "npx",
      "args": ["k0ntext", "mcp"],
      "env": {
        "K0NTEXT_PROJECT_ROOT": "${projectFolder}"
      }
    }
  }
}

Manual setup is no longer required! The MCP server works immediately after initialization.

Start the Server

# Start MCP server (auto-configured)
k0ntext mcp

Available MCP Tools

  1. search_context - Semantic search across all indexed content
  2. get_item - Get a specific context item by ID or path
  3. add_knowledge - Store new insights or facts
  4. analyze - Run intelligent analysis on codebase
  5. get_tool_configs - Get AI tool configurations
  6. query_graph - Traverse knowledge graph
  7. get_stats - Get database statistics

Available Prompts

  1. context-engineer - Initialize and configure AI context system
  2. core-architect - Design system architecture
  3. api-developer - Develop API endpoints
  4. database-ops - Database operations
  5. integration-hub - External integrations
  6. deployment-ops - CI/CD and deployment

Example MCP Tool Usage

// Search for authentication workflows
const results = await search_context({
  query: "user authentication flow",
  type: "workflow",
  limit: 5
});

// Get a specific item
const item = await get_item({
  id: "workflow:user-auth"
});

// Add new knowledge
await add_knowledge({
  name: "API Rate Limiting",
  content: "Our API uses token bucket algorithm with 1000 req/min",
  relatedTo: ["api:main-endpoint"]
});

🎨 Supported AI Tools

Fully Supported

  • Claude - AI_CONTEXT.md
  • GitHub Copilot - .github/copilot-instructions.md
  • Cursor - .cursorrules
  • Windsurf - .windsurf/rules.md
  • Cline - .clinerules
  • Aider - .aider.conf.yml
  • Continue - .continue/config.json
  • Antigravity - .agent/README.md
  • Gemini - .gemini/config.md

RPI Workflow Skills

  • @context-engineer - Setup and configuration
  • @core-architect - System design
  • @api-developer - API development
  • @database-ops - Database operations
  • @integration-hub - External integrations
  • @deployment-ops - CI/CD and deployment

🔧 Configuration

Environment Variables

Variable Description Required
OPENROUTER_API_KEY API key for intelligent analysis via OpenRouter For --intelligent flag
K0NTEXT_PROJECT_ROOT Override project root path Optional
K0NTEXT_DB_PATH Override database file path Optional

Database Location

By default, k0ntext stores its SQLite database at .k0ntext.db in the project root. This file is automatically added to .gitignore.

Tool Configuration Paths

Each AI tool has its own configuration file path:

  • Claude: AI_CONTEXT.md
  • Copilot: .github/copilot-instructions.md
  • Cursor: .cursorrules
  • Windsurf: .windsurf/rules.md
  • Cline: .clinerules
  • Aider: .aider.conf.yml
  • Continue: .continue/config.json
  • Antigravity: .agent/README.md
  • Gemini: .gemini/config.md

🏗️ Architecture

System Components

k0ntext/
├── src/                    # TypeScript source
│   ├── cli/                # CLI commands (18 commands)
│   ├── config/             # Centralized configuration (v3.1.0)
│   ├── db/                 # SQLite database client
│   ├── analyzer/           # Intelligent codebase analysis
│   ├── embeddings/         # OpenRouter integration
│   ├── agents/             # Smart agents (Cleanup, Performance, Drift, FactCheck)
│   └── mcp.ts              # MCP server implementation
├── agents/                 # Agent definitions
├── skills/                 # RPI workflow skills
├── templates/              # Output templates
└── .k0ntext.db             # SQLite database (auto-created)

Data Flow

  1. Initialization - k0ntext init discovers and analyzes codebase
  2. Indexing - k0ntext index stores content in SQLite with embeddings
  3. Generation - k0ntext generate creates tool-specific context files
  4. Sync - k0ntext sync keeps all AI tools synchronized
  5. MCP Server - k0ntext mcp provides real-time context to AI assistants

Database Schema

The SQLite database contains:

  • Context Items - Workflows, agents, commands, code, docs
  • Embeddings - Vector embeddings for semantic search
  • Relations - Knowledge graph connections
  • Sync State - Change tracking for synchronization
  • Tool Configs - AI tool configurations

🚀 Development

Build and Test

# Install dependencies
npm install

# Build the project
npm run build

# Run tests
npm test

# Run tests once (no watch)
npm run test:run

# Lint code
npm run lint

Publishing

# Dry run
npm run publish:dry

# Publish to npm
npm run publish:public

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests and linting
  5. Submit a pull request

Project Structure

  • src/cli/ - Command implementations
  • src/db/ - Database operations
  • src/analyzer/ - Code analysis logic
  • src/agents/ - Smart agents
  • templates/ - Context templates
  • .claude/ - Claude Code development context

📊 Performance Monitoring

The PerformanceMonitorAgent provides insights into:

  • Query execution times
  • Database size and growth
  • Slow query detection
  • Optimization suggestions
# View performance report
k0ntext performance

# Get JSON metrics
k0ntext performance --json

Common optimization suggestions:

  • Add indexes for frequently queried columns
  • Run VACUUM for large databases
  • Review and optimize slow queries
  • Monitor cache hit rates

🔍 Troubleshooting

Common Issues

  1. SQLite Native Extension Issues (Windows)

    # Use Node.js LTS version
node --version

  2. OpenRouter API Key Not Found

    # Set the environment variable
export OPENROUTER_API_KEY=your_api_key_here

  3. Database Locked

    # Close other instances of k0ntext
# Or wait a few seconds

  4. Permission Errors

    # Check file permissions
ls -la .k0ntext.db

Debug Mode

# Verbose output for most commands
k0ntext init -v
k0ntext index -v
k0ntext generate -v

🤝 Community

📄 License

MIT License - see LICENSE file for details.

Repository: https://github.com/SireJeff/k0ntext npm Package: https://www.npmjs.com/package/k0ntext Issues: https://github.com/SireJeff/k0ntext/issues MCP Protocol: https://modelcontextprotocol.io

Made with ❤️ by SireJeff