Universal AGENT.md Template for AI-Powered Development

AGENT.md

[Project Name]

Brief description of project purpose and architecture

Build & Commands

• Development: npm run dev
• Testing: npm test
• Build: npm run build
• Lint: npm run lint

Tech Stack

• Frontend: [Framework]
• Backend: [Technology]
• Database: [Database choice]
• Package Manager: [Tool]

Code Style

• [Language-specific conventions]
• [Formatting preferences]
• [Import/export patterns]

Architecture

• [High-level architectural patterns]
• [Directory structure]
• [Key design decisions]

Universal AGENT.md Template for AI-Powered Development

A comprehensive, community-driven template for AGENT.md files that provides standardized configuration for AI coding assistants across multiple platforms (Claude Code, Gemini CLI, Cursor, Windsurf, Kiro, and more).

Features

✅ Cross-platform compatibility via symlink strategy
✅ Complete project setup guidance
✅ Code style and architecture patterns
✅ Testing and security best practices
✅ AI-specific optimization notes
✅ Detailed usage instructions
✅ Community-maintained and MIT licensed

Perfect for both new projects and existing codebases. Simply copy, customize, and create symlinks for universal AI agent compatibility.

Platform Compatibility Notes

• Claude Code: Auto-loads from project root, supports file references via @syntax
• Gemini CLI: Reads GEMINI.md or AGENT.md, integrates with Google Cloud tools
• Cursor: Supports .cursorrules and AGENT.md via symlink
• Windsurf: Compatible with .windsurfrules format
• Kiro: Advanced integration via .kiro/steering/ directory structure

Migration Commands

ln -s AGENT.md CLAUDE.md
ln -s AGENT.md GEMINI.md  
ln -s AGENT.md .cursorrules
ln -s AGENT.md .windsurfrules

Customization Checklist

□ Update project overview with specific domain/technology
□ Modify tech stack section for your actual dependencies
□ Adapt file organization structure to your project layout
□ Customize naming conventions for your team preferences
□ Add domain-specific security requirements
□ Include project-specific testing strategies
□ Update environment variables and deployment details
□ Add any specialized AI agent instructions

Remember: This template is designed to be modified. Remove sections that
don't apply and add project-specific guidance as needed.