ai-flow-dev 2.1.2 → 2.1.4

package/templates/AGENT.template.md

@@ -3,9 +3,7 @@
 > Universal AI Assistant Configuration
 >
 > This file provides context for ALL AI development tools (Claude, Copilot, Cursor, Gemini, etc.)
-
 ---
-
 ## 📋 About This Project
 
 **Project Name:** {{PROJECT_NAME}}
@@ -33,9 +31,7 @@
 
 > This project uses AI-assisted development with comprehensive documentation.
 > All files below provide context to AI assistants for consistent, high-quality code generation.
-
 ---
-
 ## 🏗️ Documentation Architecture
 
 This project follows **AI-assisted development** with comprehensive documentation.
@@ -113,9 +109,7 @@ All documentation is structured to guide AI assistants in understanding the proj
     - Required environment variables
     - Default/local values
     - Secrets handling guidance
-
 ---
-
 ## ⚡ Quick Reference
 
 ### Tech Stack
@@ -142,9 +136,7 @@ All documentation is structured to guide AI assistants in understanding the proj
 
 **✅ ALWAYS:**
 {{ALWAYS_RULES}}
-
 ---
-
 ## 🤖 AI Assistant Workflow
 
 When working on this project:
@@ -169,9 +161,7 @@ When working on this project:
    - Follow procedures in `docs/operations.md`
    - Update configuration per environment
    - Check health endpoints
-
 ---
-
 ## 🛠️ Tool-Specific Configurations
 
 Different AI tools have specific configuration files that extend this AGENT.md:
@@ -195,9 +185,7 @@ Different AI tools have specific configuration files that extend this AGENT.md:
 - **References:** This AGENT.md + project docs
 
 **All tool-specific configs reference this AGENT.md as the source of truth.**
-
 ---
-
 ## 📊 Project Status
 
 **Current Phase:** {{PROJECT_PHASE}}
@@ -205,9 +193,7 @@ Different AI tools have specific configuration files that extend this AGENT.md:
 **Architecture:** {{ARCHITECTURE_PATTERN}}
 
 **Compliance:** {{COMPLIANCE_REQUIREMENTS}}
-
 ---
-
 ## 🚀 Getting Started
 
 ### For AI Assistants
@@ -221,9 +207,202 @@ Different AI tools have specific configuration files that extend this AGENT.md:
 ### For Developers
 
 See `README.md` for installation and setup instructions.
+---
+## 📝 Document Update Policy
+
+- Documents are **living artifacts** - update as project evolves
+- Breaking changes to architecture → Update `docs/architecture.md`
+**Architecture:** {{ARCHITECTURE_PATTERN}}
+**Primary Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
+**Framework:** {{FRAMEWORK}}
+**Database:** {{DATABASE}} with {{ORM}}
+
+**Key Characteristics:**
+
+- Authentication: {{AUTH_METHOD}}
+- API Style: {{API_STYLE}}
+- Deployment: {{DEPLOYMENT_PLATFORM}}
+- Current Phase: {{PROJECT_PHASE}}
 
+> This project uses AI-assisted development with comprehensive documentation.
+> All files below provide context to AI assistants for consistent, high-quality code generation.
 ---
+## 🏗️ Documentation Architecture
+
+This project follows **AI-assisted development** with comprehensive documentation.
+All documentation is structured to guide AI assistants in understanding the project deeply.
+
+### 📚 Core Documentation (Read in Order)
+
+1. **`ai-instructions.md`** ⭐ **START HERE**
+   - Tech stack and versions
+   - NEVER/ALWAYS rules
+   - Development workflow
+   - Priorities
+
+2. **`project-brief.md`**
+   - Business context
+   - Objectives and scope
+   - Constraints and success metrics
+
+3. **`README.md`**
+   - Quick start
+   - Installation and commands
+   - Project directory tour
+
+4. **`docs/architecture.md`**
+   - System architecture pattern
+   - Component structure
+   - Request/response flow
+
+5. **`docs/data-model.md`**
+   - Database schema
+   - Entity relationships
+   - Data patterns
+
+6. **`docs/code-standards.md`**
+   - Naming conventions
+   - Code quality rules
+   - Error handling patterns
+
+7. **`docs/testing.md`**
+   - Testing strategy
+   - Coverage requirements
+   - Test patterns
+
+8. **`docs/operations.md`**
+   - Deployment procedures
+   - Monitoring and alerts
+   - Scaling strategy
+
+9. **`docs/business-flows.md`**
+   - End-to-end business processes
+   - Key actors and systems
+   - Flow diagrams
+
+10. **`docs/api.md`**
+    - Endpoint conventions
+    - Authentication and pagination rules
+    - Request/response examples
+
+11. **`docs/contributing.md`**
+    - Development setup
+    - Contribution guidelines
+    - Code review process
+
+12. **`specs/security.md`**
+    - Authentication/Authorization
+    - Security policies
+    - Compliance requirements
+
+13. **`specs/configuration.md`**
+    - Environment variables
+    - External services
+    - Configuration by environment
 
+14. **`.env.example`**
+    - Required environment variables
+    - Default/local values
+    - Secrets handling guidance
+---
+## ⚡ Quick Reference
+
+### Tech Stack
+
+**Backend:**
+
+- Framework: {{FRAMEWORK}}
+- Language: {{LANGUAGE}} {{LANGUAGE_VERSION}}
+- Database: {{DATABASE}}
+- ORM: {{ORM}}
+- Authentication: {{AUTH_METHOD}}
+- Caching: {{CACHE_STRATEGY}}
+
+**Infrastructure:**
+
+- Deployment: {{DEPLOYMENT_PLATFORM}}
+- CI/CD: {{CICD_PLATFORM}}
+- Monitoring: {{MONITORING_TOOLS}}
+
+### Critical Rules
+
+**❌ NEVER:**
+{{NEVER_RULES}}
+
+**✅ ALWAYS:**
+{{ALWAYS_RULES}}
+---
+## 🤖 AI Assistant Workflow
+
+When working on this project:
+
+1. **Before starting ANY task:**
+   - Read `ai-instructions.md` for project-wide rules
+   - Check relevant documentation for the area you're working on
+   - Understand the business context from `project-brief.md`
+
+2. **When implementing features:**
+   - Follow architecture patterns from `docs/architecture.md`
+   - Respect data models from `docs/data-model.md`
+   - Apply code standards from `docs/code-standards.md`
+   - Add tests according to `docs/testing.md`
+
+3. **When handling security:**
+   - Consult `specs/security.md` for auth/authz
+   - Never hardcode secrets (use `specs/configuration.md`)
+   - Follow security headers and encryption requirements
+
+4. **When deploying:**
+   - Follow procedures in `docs/operations.md`
+   - Update configuration per environment
+   - Check health endpoints
+---
+## 🛠️ Tool-Specific Configurations
+
+Different AI tools have specific configuration files that extend this AGENT.md:
+
+### Claude Code
+
+- **File:** `.clauderules`
+- **Purpose:** Claude-specific instructions and preferences
+- **References:** This AGENT.md + project docs
+
+### Cursor
+
+- **File:** `.cursorrules`
+- **Purpose:** Cursor-specific context and rules
+- **References:** This AGENT.md + project docs
+
+### GitHub Copilot
+
+- **File:** `.github/copilot-instructions.md`
+- **Purpose:** Copilot workspace instructions
+- **References:** This AGENT.md + project docs
+
+**All tool-specific configs reference this AGENT.md as the source of truth.**
+---
+## 📊 Project Status
+
+**Current Phase:** {{PROJECT_PHASE}}
+
+**Architecture:** {{ARCHITECTURE_PATTERN}}
+
+**Compliance:** {{COMPLIANCE_REQUIREMENTS}}
+---
+## 🚀 Getting Started
+
+### For AI Assistants
+
+1. Read this AGENT.md completely
+2. Read `ai-instructions.md` for critical rules
+3. Familiarize with `docs/architecture.md`
+4. Review `docs/code-standards.md` for coding patterns
+5. Check `specs/security.md` before handling auth/sensitive data
+
+### For Developers
+
+See `README.md` for installation and setup instructions.
+---
 ## 📝 Document Update Policy
 
 - Documents are **living artifacts** - update as project evolves
@@ -233,4 +412,4 @@ See `README.md` for installation and setup instructions.
 
 **Last Updated:** {{GENERATION_DATE}}
 
-**Generated by:** AI Flow v2.1.2
+**Generated by:** AI Flow v2.1.4

package/templates/backend/README.template.md

@@ -1,35 +1,27 @@
 # {{PROJECT_NAME}}
 
 > {{PROJECT_DESCRIPTION}}
-
 ---
-
 ## 📋 Overview
 
 {{PROBLEM_STATEMENT}}
 
 **Target Users:** {{TARGET_USERS_SUMMARY}}
-
 ---
-
 ## ✨ Features
 
 {{#EACH FEATURE}}
 
 - **{{FEATURE_NAME}}**: {{FEATURE_DESCRIPTION}}
   {{/EACH}}
-
 ---
-
 ## 🏗️ Tech Stack
 
 - **Framework:** {{FRAMEWORK}} {{FRAMEWORK_VERSION}}
 - **Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
 - **Database:** {{DATABASE}}
 - **Authentication:** {{AUTH_METHOD}}
-
 ---
-
 ## 🚀 Getting Started
 
 ### Prerequisites
@@ -66,9 +58,7 @@ cp .env.example .env
 ```
 
 The application will be available at `{{DEV_URL}}`
-
 ---
-
 ## 🧪 Testing
 
 ```bash
@@ -81,9 +71,7 @@ The application will be available at `{{DEV_URL}}`
 # Run specific tests
 {{TEST_SPECIFIC_COMMAND}}
 ```
-
 ---
-
 ## 📦 Building
 
 ```bash
@@ -93,9 +81,7 @@ The application will be available at `{{DEV_URL}}`
 # Start production server
 {{PROD_COMMAND}}
 ```
-
 ---
-
 ## 🔧 Available Scripts
 
 ```bash
@@ -105,17 +91,13 @@ The application will be available at `{{DEV_URL}}`
 
 {{/EACH}}
 ```
-
 ---
-
 ## 📁 Project Structure
 
 ```
 {{PROJECT_STRUCTURE}}
 ```
-
 ---
-
 ## 📚 Documentation
 
 - [Architecture](docs/architecture.md) - System architecture and design patterns
@@ -133,9 +115,7 @@ The application will be available at `{{DEV_URL}}`
 
 - [AGENT.md](AGENT.md) - Universal AI configuration
 - [AI Instructions](ai-instructions.md) - AI development rules and workflow
-
 ---
-
 ## 🔐 Environment Variables
 
 See `.env.example` for all required environment variables.
@@ -145,9 +125,7 @@ Critical variables:
 
 - `{{VAR_NAME}}` - {{VAR_DESCRIPTION}}
   {{/EACH}}
-
 ---
-
 ## 🚀 Deployment
 
 See [docs/operations.md](docs/operations.md) for deployment procedures.
@@ -159,9 +137,7 @@ See [docs/operations.md](docs/operations.md) for deployment procedures.
 - Development: {{DEV_URL}}
 - Staging: {{STAGING_URL}}
 - Production: {{PRODUCTION_URL}}
-
 ---
-
 ## 🤝 Contributing
 
 See [docs/contributing.md](docs/contributing.md) for contribution guidelines.
@@ -171,30 +147,24 @@ See [docs/contributing.md](docs/contributing.md) for contribution guidelines.
 3. Commit changes (`git commit -m 'feat: add amazing feature'`)
 4. Push to branch (`git push origin feature/amazing-feature`)
 5. Open Pull Request
-
 ---
-
 ## 📝 License
 
 {{LICENSE}}
-
 ---
-
 ## 👥 Team
 
 {{#EACH TEAM_MEMBER}}
 
 - **{{MEMBER_NAME}}** - {{MEMBER_ROLE}}
   {{/EACH}}
-
 ---
-
 ## 📞 Support
 
 {{#IF SUPPORT_EMAIL}}- Email: {{SUPPORT_EMAIL}}{{/IF}}
 {{#IF SUPPORT_SLACK}}- Slack: {{SUPPORT_SLACK}}{{/IF}}
 {{#IF ISSUE_TRACKER}}- Issues: {{ISSUE_TRACKER}}{{/IF}}
-
 ---
-
 **Generated with** [AI Flow](https://github.com/victorvelazquez/ai-flow) | `npm i -g ai-flow-dev` 🚀
+
+

package/templates/backend/ai-instructions.template.md

@@ -1,9 +1,7 @@
 # AI Instructions
 
 > **CRITICAL:** Every AI assistant MUST read and follow this document before any work.
-
 ---
-
 ## 🎯 Project Overview
 
 **Name:** {{PROJECT_NAME}}
@@ -11,9 +9,7 @@
 **Description:** {{PROJECT_DESCRIPTION}}
 
 **Purpose:** {{PROBLEM_STATEMENT}}
-
 ---
-
 ## 🏗️ Tech Stack
 
 ### Backend
@@ -45,9 +41,7 @@
 ### Key Libraries
 
 {{KEY_LIBRARIES}}
-
 ---
-
 ## 🏛️ Architecture
 
 **Pattern:** {{ARCHITECTURE_PATTERN}}
@@ -55,9 +49,7 @@
 {{ARCHITECTURE_DESCRIPTION}}
 
 **File Organization:** {{FILE_ORGANIZATION}}
-
 ---
-
 ## ❌ NEVER Rules
 
 **YOU MUST NEVER:**
@@ -99,9 +91,7 @@
 - ❌ Commit failing tests - All tests must pass before commit
 
 {{CUSTOM_NEVER_RULES}}
-
 ---
-
 ## ✅ ALWAYS Rules
 
 **YOU MUST ALWAYS:**
@@ -157,9 +147,7 @@
 - ✅ Implement pagination for list endpoints
 
 {{CUSTOM_ALWAYS_RULES}}
-
 ---
-
 ## 🔄 Development Workflow
 
 ### 1. Before Starting a Task
@@ -196,9 +184,7 @@
 - Update CHANGELOG.md
 - Test in staging before production
 - Monitor logs after deployment
-
 ---
-
 ## 🎯 Priorities
 
 When there are trade-offs, prioritize in this order:
@@ -208,17 +194,13 @@ When there are trade-offs, prioritize in this order:
 3. **{{PRIORITY_3}}** - {{PRIORITY_3_DESCRIPTION}}
 4. **{{PRIORITY_4}}** - {{PRIORITY_4_DESCRIPTION}}
 5. **{{PRIORITY_5}}** - {{PRIORITY_5_DESCRIPTION}}
-
 ---
-
 ## 📁 Project Structure
 
 ```
 {{PROJECT_STRUCTURE}}
 ```
-
 ---
-
 ## 🧪 Testing Commands
 
 ```bash
@@ -237,9 +219,7 @@ When there are trade-offs, prioritize in this order:
 # Run specific test file
 {{TEST_SPECIFIC_COMMAND}}
 ```
-
 ---
-
 ## 🚀 Common Commands
 
 ```bash
@@ -264,9 +244,7 @@ When there are trade-offs, prioritize in this order:
 # Create new migration
 {{MIGRATION_CREATE_COMMAND}}
 ```
-
 ---
-
 ## 📚 Key Documentation Files
 
 - `project-brief.md` - Business context and objectives
@@ -281,18 +259,14 @@ When there are trade-offs, prioritize in this order:
 - `specs/security.md` - Security policies and compliance
 - `specs/configuration.md` - Environment configuration
 - `docs/contributing.md` - Development setup, workflow
-
 ---
-
 ## 🔐 Environment Variables
 
 See `.env.example` for all required environment variables.
 
 **Critical variables:**
 {{CRITICAL_ENV_VARS}}
-
 ---
-
 ## 🛡️ Security Checklist
 
 Before every feature:
@@ -306,9 +280,7 @@ Before every feature:
 - [ ] SQL injection prevented (parameterized queries)
 - [ ] XSS prevented (output encoding)
 - [ ] CSRF protection (if stateful)
-
 ---
-
 ## 🎨 Code Style Examples
 
 ### Controller Example ({{FRAMEWORK}})
@@ -334,9 +306,7 @@ Before every feature:
 ```{{LANGUAGE}}
 {{DTO_EXAMPLE}}
 ```
-
 ---
-
 ## 📞 When in Doubt
 
 1. Check this document first
@@ -344,11 +314,11 @@ Before every feature:
 3. Look for similar existing implementations in the codebase
 4. Ask for clarification before making architectural decisions
 5. Prioritize security and maintainability over speed
-
 ---
-
 **Remember:** These rules exist to maintain quality, security, and consistency. Following them makes the codebase better for everyone.
 
 **Last Updated:** {{GENERATION_DATE}}
 
 **Generated by:** AI Flow v1.0.0
+
+

package/templates/backend/copilot-instructions.template.md

@@ -7,9 +7,7 @@
 **Description:** {{PROJECT_DESCRIPTION}}
 
 **Stack:** {{FRAMEWORK}} ({{LANGUAGE}}) + {{DATABASE}}
-
 ---
-
 ## 📚 Documentation Reference
 
 **⭐ CRITICAL:** Always read `AGENT.md` first for complete context.
@@ -30,9 +28,7 @@
 - [`docs/contributing.md`](../../docs/contributing.md) - Contribution workflow
 - [`specs/security.md`](../../specs/security.md) - Security policies
 - [`specs/configuration.md`](../../specs/configuration.md) - Environment configuration
-
 ---
-
 ## 🎯 Quick Rules
 
 ### ❌ NEVER
@@ -42,9 +38,7 @@
 ### ✅ ALWAYS
 
 {{ALWAYS_RULES_SUMMARY}}
-
 ---
-
 ## 🏗️ Architecture
 
 **Pattern:** {{ARCHITECTURE_PATTERN}}
@@ -54,9 +48,7 @@
 ```
 {{PROJECT_STRUCTURE_BRIEF}}
 ```
-
 ---
-
 ## 🎨 Code Style
 
 | Setting     | Value           |
@@ -67,9 +59,7 @@
 | Formatter   | {{FORMATTER}}   |
 
 **Auto-format:** {{AUTO_FORMAT_COMMAND}}
-
 ---
-
 ## 🔐 Security
 
 - **Auth:** {{AUTH_METHOD}}
@@ -77,9 +67,7 @@
 - **Password:** {{PASSWORD_HASH_ALGORITHM}}
 - **NEVER** hardcode secrets
 - **ALWAYS** validate user input
-
 ---
-
 ## 🧪 Testing
 
 - **Framework:** {{TEST_FRAMEWORK}}
@@ -91,17 +79,13 @@
 ```{{LANGUAGE}}
 {{TEST_PATTERN_EXAMPLE}}
 ```
-
 ---
-
 ## 📝 Commit Format
 
 ```
 {{COMMIT_FORMAT_EXAMPLE}}
 ```
-
 ---
-
 ## 💡 Copilot Workflow
 
 1. Read `AGENT.md` for project context
@@ -109,9 +93,7 @@
 3. Follow patterns from `docs/code-standards.md`
 4. Write tests alongside code
 5. Validate with linter before committing
-
 ---
-
 ## 🔧 Common Commands
 
 ```bash
@@ -130,9 +112,7 @@
 # Build
 {{BUILD_COMMAND}}
 ```
-
 ---
-
 ## 🎯 Code Examples
 
 ### Controller
@@ -152,9 +132,9 @@
 ```{{LANGUAGE}}
 {{REPOSITORY_EXAMPLE_BRIEF}}
 ```
-
 ---
-
 **For complete context, always reference `AGENT.md` and project documentation.**
 
 **Generated by:** AI Flow v1.0.0
+
+