Getting Started
Add EngXMax to your project in under 5 minutes and start getting consistent, high-quality output from your AI coding assistant.
1Prerequisites
Git
Installed on your system
Project repo
Existing or new
AI assistant
Copilot, Cursor, Claude, or Windsurf
2Installation
Git Submodule
This keeps your context pack in sync with the latest updates automatically.
cd your-project
git submodule add https://github.com/EngXMax/engxmax .ai-context
git commit -m "chore: add engxmax context pack"Alternative: Direct copy (no auto-updates)
git clone https://github.com/EngXMax/engxmax.git temp-engxmax
cp -r temp-engxmax your-project/.ai-context
rm -rf temp-engxmax3Generate Adapter
Run setup with your IDE and stack. This creates ONE adapter file for your IDE.
.ai-context/scripts/setup.sh --ide copilot --stack react-typescriptIDE Options
--ide copilotGitHub Copilot--ide cursorCursor--ide windsurfWindsurf--ide claudeClaude CodeStack Options
--stack react-typescriptReact + TypeScript--stack pythonPython--stack node-backendNode.js Backend--stack goGo--stack rustRustResult: Creates one file (e.g., .github/copilot-instructions.md for Copilot) that tells your AI to read from .ai-context/and follow your PRD if it exists.
★PRD Integration
EngXMax automatically instructs AI to read and follow your PRD.md if it exists in your project root. This ensures all AI work aligns with your product vision.
When AI sees PRD.md, it will:
No PRD yet? No problem — EngXMax works perfectly without one. When you're ready, simply create PRD.md in your project root and AI will automatically start following it.
4Customize
Edit PROJECT_AI_CONTEXT.md to describe your project. The more context you provide, the better your AI assistant will perform.
# Open and fill in your project context
nano PROJECT_AI_CONTEXT.mdOptional: Add more context files
PRD.mdProduct Requirements Document — AI reads this first as the master reference
Create your own PRD with your product vision, features, architecture, and roadmap. AI will read and follow it.
PROTECTED_FILES.mdList files AI should never modify (configs, generated code, etc.)
cp .ai-context/templates/protected-files.md PROTECTED_FILES.mdDOMAIN.mdIndustry-specific terms, compliance requirements, business rules
cp .ai-context/templates/domain.md DOMAIN.md5Verify Setup
Run the validation script to ensure everything is configured correctly.
./.ai-context/scripts/validate.sh
# Expected output:
✓ Core rules present
✓ Stack patterns loaded
✓ IDE adapters generated
✓ All validations passed6Staying Up to Date
With the submodule approach, pulling the latest EngXMax improvements is simple. Your AI assistant automatically benefits from new rules, patterns, and fixes.
# Pull latest EngXMax updates
git submodule update --remote .ai-context
# Commit the update to your project
git add .ai-context
git commit -m "chore: pull latest engxmax updates"Pro tip: Run this periodically to get the latest AI behavior improvements, new stack patterns, and bug fixes — all without changing your project's custom configuration.