Real-world examples of using create-ai-context in different scenarios.
⚛️ New React Project
Setting up AI context for a new React TypeScript project:
# Create new project
mkdir my-react-app
cd my-react-app
# Initialize with npm
npm init -y
npm install react react-dom typescript
# Generate AI context
npx create-ai-context
Result: Tool detects React/TypeScript, provides smart defaults, creates complete AI documentation structure.
🐍 Existing Python Project
Adding AI context to an existing Django project:
# Navigate to existing project
cd existing-django-project
# Generate AI context (safe mode)
npx create-ai-context
Interactive Flow:
- Tool detects Python/Django from requirements.txt
- Warns about existing README.md
- Offers options: overwrite, skip, or choose individually
- Creates missing AI context files only
🔄 CI/CD Automation
Automated setup in CI/CD pipeline for consistent documentation:
# In your GitHub Actions workflow
- name: Setup AI Context
run: |
npx create-ai-context --agent claude --path ./
git add *.md docs/
git commit -m "docs: add AI context files"
Result: Ensures all repositories have consistent AI documentation structure.
🏢 Enterprise Microservices
Standardizing documentation across multiple microservices:
# For each service
cd user-service
npx create-ai-context --agent cursor --path ./
cd payment-service
npx create-ai-context --agent cursor --path ./
cd notification-service
npx create-ai-context --agent cursor --path ./
Result: Consistent documentation structure across all services, easier for AI assistants to understand the entire system.
🧠 AI-First Development
Starting a new project with AI assistance from day one:
# Create project directory
mkdir ai-powered-app
cd ai-powered-app
# Generate AI context first
npx create-ai-context --agent claude --path ./
# Load context into Claude Code
/memory add PROJECT_RULES.md
/memory add DEVELOPMENT_PLAN.md
cat ai-instructions.md
AI Development Flow:
- Generate base documentation templates
- Use AI to analyze requirements and populate templates
- AI creates detailed architecture based on project rules
- Begin coding with full AI context understanding
- Clean up ai-instructions.md when setup is complete
📱 Mobile App Development
Setting up documentation for a React Native mobile app:
# Initialize React Native project
npx react-native init MyMobileApp
cd MyMobileApp
# Add AI context for better team collaboration
npx create-ai-context
# Share with team
git add *.md docs/
git commit -m "docs: add AI-optimized project documentation"
git push
Result: Team members and AI assistants have clear understanding of mobile app architecture, development guidelines, and project structure.
🔧 Legacy Code Documentation
Adding modern documentation to legacy codebases:
# Navigate to legacy project
cd legacy-php-app
# Generate modern documentation structure
npx create-ai-context
# Use AI to analyze and document existing code
cat ai-instructions.md
# Follow AI guidance to populate architecture docs
Result: Legacy project gets modern documentation structure, making it easier for new developers and AI assistants to understand and maintain.
🎯 Best Practices from Examples
- Start Early: Add AI context from project inception for maximum benefit
- Use Direct Mode for Automation: Perfect for CI/CD and batch operations
- Interactive Mode for Existing Projects: Safely handles existing files
- Team Standardization: Use across all projects for consistent documentation
- AI-First Workflow: Let AI help populate templates based on your requirements
- Version Control: Commit documentation changes for team collaboration
📊 Success Metrics
Teams using create-ai-context report:
- 50% faster onboarding for new developers
- 30% more consistent AI assistant responses
- Reduced documentation debt across projects
- Better architectural decisions with versioned planning
- Improved team communication through standardized docs