create-ai-context

Generate AI-optimized project documentation and context files for better AI-assisted development

🎯

Smart Detection

Auto-detects project types and generates appropriate documentation

🤖

AI-Optimized

Templates designed specifically for AI assistant context

🔄

Version Control

Track changes to strategic documents over time

🛡️

Smart File Handling

Detects existing documentation and offers safe overwrite options

🧭

Path Validation

Validates directories and guides users to correct paths

🌿

Git Worktree Support

Advanced parallel development workflows with comprehensive guidance

Quickstart

📦 Step 1: Generate Templates

# Interactive mode (recommended for first time)
npx create-ai-context

# Direct mode for automation
npx create-ai-context --agent claude --path ./my-project

# Force overwrite existing files
npx create-ai-context --agent claude --path ./my-project --force

New: Smart handling of existing documentation files with safe overwrite options!

🤖 Step 2: Use with Your AI Tool

For Claude Code:

claude ai-instructions.md  # Copy and follow the steps

For Cursor:

# Open Cursor → Chat → Type:
@ai-instructions.md

For Other AI Tools:

# Open ai-instructions.md and copy the prompts
# Files are ready for AI context loading

🗑️ Step 3: Clean Up (Optional)

# After AI analysis is complete
rm ai-instructions.md

📋 Generated Files Overview

Root Directory (3 Essential Files):

  • DEVELOPMENT_PLAN.md - Project roadmap + development guidelines
  • ARCHITECTURE.md - Technical architecture + code standards
  • ai-instructions.md - AI setup guidance (temporary)

docs/ Directory: Used only for this website documentation.

🛠️ CLI Options

Option Description
--agent <name> AI agent to optimize for (claude, cursor, codex)
--path <directory> Target directory for templates
--help Show help information
--version Show version number

🏗️ Project Structure

your-project/
├── DEVELOPMENT_PLAN.md    # 📋 Project roadmap + guidelines
├── ARCHITECTURE.md        # 🏛️ System architecture + standards
├── ai-instructions.md     # 🧠 AI setup (temporary)
└── src/                   # 💻 Your source code
💡 Pro Tip: Start with create-ai-context from day one of your project for maximum benefit. The templates are designed to grow with your project.

🚀 Best Practices

  1. Start Early - Run on new projects from day one
  2. Safe Updates - Tool respects existing files, asks before overwriting
  3. Version Changes - Use version tables for important decisions
  4. Keep Current - Update documentation as project evolves
  5. Follow Rules - Use PROJECT_RULES.md to maintain consistency

Requirements

  • Node.js 14.0.0 or higher
  • npm, yarn, or other package manager
  • Git (recommended for version tracking)
Get Started on NPM View on GitHub