vibe-coding-ai-rules AGENTS.md

AGENTS.md - Universal AI Agent Configuration

This file follows the AGENTS.md standard, supported by Cursor, GitHub Copilot, Codex, Aider, and other AI coding tools. Place this file in your project root and customize the sections below for your project.

[Project Name]

Project Overview

[Brief description of the project's purpose and core functionality]

Architecture: [e.g., Microservices, Monolith, JAMstack] Domain: [e.g., E-commerce, Healthcare, Finance] Scale: [e.g., Startup MVP, High-traffic production, Enterprise]

Tech Stack

Core Technologies

• Language: [Python 3.11+, TypeScript 5.x, etc.]
• Framework: [FastAPI, Next.js, Spring Boot, etc.]
• Database: [PostgreSQL 15, MongoDB 6, etc.]
• Cache: [Redis 7, Memcached, etc.]
• Package Manager: [npm, pnpm, pip, poetry, etc.]

Key Dependencies

• [Library/Framework]: [Version and purpose]
• [Library/Framework]: [Version and purpose]

Development Tools

• Linter: [ESLint, Pylint, etc.]
• Formatter: [Prettier, Black, etc.]
• Type Checker: [TypeScript, mypy, etc.]
• Testing: [Vitest, pytest, JUnit, etc.]

Setup Commands

# Install dependencies
[install command]

# Setup environment
cp .env.example .env
# Edit .env with required values

# Database setup
[migration commands]

# Start development server
[dev command]

Build and Development Commands

File-Scoped Commands (Preferred - Fast)

# Type check single file (3 seconds)
[command] path/to/file.ext

# Format single file
[command] path/to/file.ext

# Lint single file
[command] path/to/file.ext

# Run single test file
[command] path/to/test.ext

Project-Wide Commands (Use Sparingly)

# Full type check (2 minutes)
[command]

# Full test suite (3 minutes)
[command]

# Full build (5 minutes)
[command]

Important: Always use file-scoped commands for checking individual changes. Only run project-wide commands when explicitly requested or before final commit.