UNPKG

aios-core

Version:

Synkra AIOS: AI-Orchestrated System for Full Stack Development - Core Framework

361 lines (255 loc) 10.3 kB
--- # Template selection determined dynamically during task execution # User selects from available templates in .aios-core/product/templates/ tools: - github-cli # For file operations utils: - template-engine - template-validator --- # Create Document from Template (YAML Driven) ## Execution Modes **Choose your execution mode:** ### 1. YOLO Mode - Fast, Autonomous (0-1 prompts) - Autonomous decision making with logging - Minimal user interaction - **Best for:** Simple, deterministic tasks ### 2. Interactive Mode - Balanced, Educational (5-10 prompts) **[DEFAULT]** - Explicit decision checkpoints - Educational explanations - **Best for:** Learning, complex decisions ### 3. Pre-Flight Planning - Comprehensive Upfront Planning - Task analysis phase (identify all ambiguities) - Zero ambiguity execution - **Best for:** Ambiguous requirements, critical work **Parameter:** `mode` (optional, default: `interactive`) --- ## Task Definition (AIOS Task Format V1.0) ```yaml task: createDoc() responsável: Morgan (Strategist) responsavel_type: Agente atomic_layer: Template **Entrada:** - campo: name tipo: string origem: User Input obrigatório: true validação: Must be non-empty, lowercase, kebab-case - campo: options tipo: object origem: User Input obrigatório: false validação: Valid JSON object with allowed keys - campo: force tipo: boolean origem: User Input obrigatório: false validação: Default: false **Saída:** - campo: created_file tipo: string destino: File system persistido: true - campo: validation_report tipo: object destino: Memory persistido: false - campo: success tipo: boolean destino: Return value persistido: false ``` --- ## Pre-Conditions **Purpose:** Validate prerequisites BEFORE task execution (blocking) **Checklist:** ```yaml pre-conditions: - [ ] Target does not already exist; required inputs provided; permissions granted tipo: pre-condition blocker: true validação: | Check target does not already exist; required inputs provided; permissions granted error_message: "Pre-condition failed: Target does not already exist; required inputs provided; permissions granted" ``` --- ## Post-Conditions **Purpose:** Validate execution success AFTER task completes **Checklist:** ```yaml post-conditions: - [ ] Resource created successfully; validation passed; no errors logged tipo: post-condition blocker: true validação: | Verify resource created successfully; validation passed; no errors logged error_message: "Post-condition failed: Resource created successfully; validation passed; no errors logged" ``` --- ## Acceptance Criteria **Purpose:** Definitive pass/fail criteria for task completion **Checklist:** ```yaml acceptance-criteria: - [ ] Resource exists and is valid; no duplicate resources created tipo: acceptance-criterion blocker: true validação: | Assert resource exists and is valid; no duplicate resources created error_message: "Acceptance criterion not met: Resource exists and is valid; no duplicate resources created" ``` --- ## Tools **External/shared resources used by this task:** - **Tool:** component-generator - **Purpose:** Generate new components from templates - **Source:** .aios-core/scripts/component-generator.js - **Tool:** file-system - **Purpose:** File creation and validation - **Source:** Node.js fs module --- ## Scripts **Agent-specific code for this task:** - **Script:** create-component.js - **Purpose:** Component creation workflow - **Language:** JavaScript - **Location:** .aios-core/scripts/create-component.js --- ## Error Handling **Strategy:** retry **Common Errors:** 1. **Error:** Resource Already Exists - **Cause:** Target file/resource already exists in system - **Resolution:** Use force flag or choose different name - **Recovery:** Prompt user for alternative name or force overwrite 2. **Error:** Invalid Input - **Cause:** Input name contains invalid characters or format - **Resolution:** Validate input against naming rules (kebab-case, lowercase, no special chars) - **Recovery:** Sanitize input or reject with clear error message 3. **Error:** Permission Denied - **Cause:** Insufficient permissions to create resource - **Resolution:** Check file system permissions, run with elevated privileges if needed - **Recovery:** Log error, notify user, suggest permission fix --- ## Performance **Expected Metrics:** ```yaml duration_expected: 3-8 min (estimated) cost_estimated: $0.002-0.005 token_usage: ~1,500-5,000 tokens ``` **Optimization Notes:** - Cache template compilation; minimize data transformations; lazy load resources --- ## Metadata ```yaml story: N/A version: 1.0.0 dependencies: - N/A tags: - creation - setup updated_at: 2025-11-17 ``` --- ## Execution Dependencies **Utils:** template-engine, template-validator ## ⚠️ CRITICAL EXECUTION NOTICE ⚠️ **THIS IS AN EXECUTABLE WORKFLOW - NOT REFERENCE MATERIAL** When this task is invoked: 1. **DISABLE ALL EFFICIENCY OPTIMIZATIONS** - This workflow requires full user interaction 2. **MANDATORY STEP-BY-STEP EXECUTION** - Each section must be processed sequentially with user feedback 3. **ELICITATION IS REQUIRED** - When `elicit: true`, you MUST use the 1-9 format and wait for user response 4. **NO SHORTCUTS ALLOWED** - Complete documents cannot be created without following this workflow **VIOLATION INDICATOR:** If you create a complete document without user interaction, you have violated this workflow. ## Critical: Template Discovery If a YAML Template has not been provided, list all templates from .aios-core/product/templates or ask the user to provide another. ## CRITICAL: Mandatory Elicitation Format **When `elicit: true`, this is a HARD STOP requiring user interaction:** **YOU MUST:** 1. Present section content 2. Provide detailed rationale (explain trade-offs, assumptions, decisions made) 3. **STOP and present numbered options 1-9:** - **Option 1:** Always "Proceed to next section" - **Options 2-9:** Select 8 methods from data/elicitation-methods - End with: "Select 1-9 or just type your question/feedback:" 4. **WAIT FOR USER RESPONSE** - Do not proceed until user selects option or provides feedback **WORKFLOW VIOLATION:** Creating content for elicit=true sections without user interaction violates this task. **NEVER ask yes/no questions or use any other format.** ## Code Intelligence: Codebase Intelligence Section (Optional — Auto-skip if unavailable) > **Condition:** Only execute if `isCodeIntelAvailable()` returns true AND the document being created is a PRD or architecture document. > If no code intelligence provider is available, skip this enhancement silently. When creating PRDs or architecture documents with code intelligence available, add a "Codebase Intelligence" section: ```javascript const { isCodeIntelAvailable } = require('.aios-core/core/code-intel'); const { getCodebaseOverview, getDependencyGraph } = require('.aios-core/core/code-intel/helpers/planning-helper'); if (isCodeIntelAvailable()) { const overview = await getCodebaseOverview('.'); const depGraph = await getDependencyGraph('.'); // Add optional section to generated document: // - overview.codebase: project patterns, file groups, architecture // - overview.stats: file counts, language distribution, LOC // - depGraph.summary: { totalDeps, depth } } ``` **If data is available, append this section to the generated document:** ```markdown ## Codebase Intelligence > Auto-generated from code intelligence provider. Real codebase data, not estimates. ### Project Overview {{overview.codebase summary patterns, file groups, architecture}} ### Statistics {{overview.stats file counts, language distribution}} ### Dependency Summary - **Total Dependencies:** {{depGraph.summary.totalDeps}} - **Dependency Depth:** {{depGraph.summary.depth}} ``` > **Note:** This section is optional and only appears when a code intelligence provider is available. The document is fully functional without it. --- ## Processing Flow 1. **Parse YAML template** - Load template metadata and sections 2. **Set preferences** - Show current mode (Interactive), confirm output file 3. **Process each section:** - Skip if condition unmet - Check agent permissions (owner/editors) - note if section is restricted to specific agents - Draft content using section instruction - Present content + detailed rationale - **IF elicit: true** MANDATORY 1-9 options format - Save to file if possible 4. **Continue until complete** ## Detailed Rationale Requirements When presenting section content, ALWAYS include rationale that explains: - Trade-offs and choices made (what was chosen over alternatives and why) - Key assumptions made during drafting - Interesting or questionable decisions that need user attention - Areas that might need validation ## Elicitation Results Flow After user selects elicitation method (2-9): 1. Execute method from data/elicitation-methods 2. Present results with insights 3. Offer options: - **1. Apply changes and update section** - **2. Return to elicitation menu** - **3. Ask any questions or engage further with this elicitation** ## Agent Permissions When processing sections with agent permission fields: - **owner**: Note which agent role initially creates/populates the section - **editors**: List agent roles allowed to modify the section - **readonly**: Mark sections that cannot be modified after creation **For sections with restricted access:** - Include a note in the generated document indicating the responsible agent - Example: "_(This section is owned by dev-agent and can only be modified by dev-agent)_" ## YOLO Mode User can type `#yolo` to toggle to YOLO mode (process all sections at once). ## CRITICAL REMINDERS **❌ NEVER:** - Ask yes/no questions for elicitation - Use any format other than 1-9 numbered options - Create new elicitation methods **✅ ALWAYS:** - Use exact 1-9 format when elicit: true - Select options 2-9 from data/elicitation-methods only - Provide detailed rationale explaining decisions - End with "Select 1-9 or just type your question/feedback:"