diff --git a/README.md b/README.md
index 3ef2092..8fc4905 100644
--- a/README.md
+++ b/README.md
@@ -6,25 +6,8 @@ Welcome to the **Prompt Library**, a collection of categorized AI prompts for ea
## 📚 Table of Contents
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-- [🎯 Purpose & Features](#-purpose--features)
-- [⚡ Quick Start](#-quick-start)
-- [🛠️ How It Works](#-how-it-works)
-- [🖥️ CLI Usage](#-cli-usage)
- - [Interactive Menu](#interactive-menu)
- - [List Prompts and Categories](#list-prompts-and-categories)
- - [Sync Personal Library](#sync-personal-library)
- - [Execute Prompts](#execute-prompts)
-- [📂 Prompt Library Example](#-prompt-library-example)
-- [🚀 Getting Started](#-getting-started)
-- [🧩 Using Fragments](#-using-fragments)
-- [⚙️ Metadata Customization](#-metadata-customization)
-- [🤝 Contributing](#-contributing)
-- [📄 License](#-license)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- START doctoc -->
+<!-- END doctoc -->
## 🎯 Purpose & Features
@@ -128,10 +111,18 @@ prompt-library-cli execute --help
- [Git Branch Name Generator](prompts/git_branch_name_generator/README.md) - Generates optimized git branch names based on project context and user requirements
- [Git Commit Message Agent](prompts/git_commit_message_agent/README.md) - Generates precise and informative git commit messages following Conventional Commits specification
+- [Software Architect Visionary](prompts/software_architect_agent/README.md) - Analyzes user requirements and creates comprehensive software specification documents
- [GitHub Issue Creator](prompts/github_issue_creator_agent/README.md) - Creates comprehensive and actionable GitHub issues based on provided project information
+- [Software Architect Specification Creator](prompts/software_architect_spec_creator/README.md) - Creates comprehensive software specification documents based on user requirements
- [Software Architect Code Reviewer](prompts/software_architect_code_reviewer/README.md) - Generates comprehensive pull requests with architectural analysis and optimization suggestions
- [Software Development Expert Agent](prompts/software_dev_expert_agent/README.md) - Provides expert, adaptive assistance across all aspects of the software development lifecycle.
+</details>
+<details>
+<summary><strong>Content Creation</strong></summary>
+
+- [Documentation Specialist Agent](prompts/documentation_specialist_agent/README.md) - Generates revolutionary software documentation using advanced AI techniques and industry best practices
+
</details>
<details>
<summary><strong>Healthcare</strong></summary>
@@ -150,9 +141,7 @@ prompt-library-cli execute --help
<summary><strong>Prompt Engineering</strong></summary>
- [AI Assistant Architect](prompts/ai_assistant_architect/README.md) - Conceptualizes innovative and feasible AI assistant designs for various domains
-- [Advanced Documentation Agent](prompts/advanced_documentation_agent/README.md) - Generates revolutionary, next-generation software documentation using advanced AI techniques
- [Prompt Engineering God](prompts/prompt_engineering_agent/README.md) - Crafts divine-tier prompts to maximize AI potential while adhering to ethical standards
-- [Software Engineering Architect Agent](prompts/software_engineering_architect/README.md) - Analyzes requirements and creates comprehensive software specification documents
</details>
<details>
diff --git a/prompts/advanced_documentation_agent/metadata.yml b/prompts/advanced_documentation_agent/metadata.yml
deleted file mode 100644
index 2aba016..0000000
--- a/prompts/advanced_documentation_agent/metadata.yml
+++ /dev/null
@@ -1,62 +0,0 @@
-content_hash: 604ea79d6796e71361a317c27cdcfcf2
-description: >-
- This prompt creates an AI agent specialized in producing cutting-edge software
- documentation. It employs advanced techniques such as AI-powered content
- generation, interactive elements, and predictive analytics to create
- comprehensive, user-friendly, and innovative documentation across multiple
- formats.
-directory: advanced_documentation_agent
-fragments:
- - category: prompt_engineering
- name: formatting_guidelines
- variable: '{{FORMATTING_GUIDELINES}}'
- - category: prompt_engineering
- name: safety_guidelines
- variable: '{{SAFETY_GUIDELINES}}'
- - category: prompt_engineering
- name: behavior_attributes
- variable: '{{AI_BEHAVIOR_ATTRIBUTES}}'
-one_line_description: >-
- Generates revolutionary, next-generation software documentation using advanced
- AI techniques
-primary_category: prompt_engineering
-subcategories:
- - technical_writing
- - software_documentation
-tags:
- - AI_documentation
- - API_docs
- - technical_writing
- - software_engineering
- - innovation
-title: Advanced Documentation Agent
-variables:
- - name: '{{PROJECT_REQUIREMENTS}}'
- optional_for_user: false
- role: Defines the specific documentation needs and goals for the project
- - name: '{{EXISTING_DOCS}}'
- optional_for_user: false
- role: Provides any existing documentation to be analyzed and improved upon
- - name: '{{CODEBASE}}'
- optional_for_user: false
- role: >-
- Contains the project's source code for analysis and documentation
- generation
- - name: '{{SAFETY_GUIDELINES}}'
- optional_for_user: true
- role: Specifies any safety or ethical considerations to be followed
- - name: '{{AI_BEHAVIOR_ATTRIBUTES}}'
- optional_for_user: false
- role: Defines specific behavioral traits for the AI agent
- - name: '{{USER_BEHAVIOR_PREFERENCES}}'
- optional_for_user: true
- role: Allows users to specify their preferences for AI interaction
- - name: '{{FORMATTING_GUIDELINES}}'
- optional_for_user: false
- role: Provides specific formatting requirements for the documentation
- - name: '{{OUTPUT_FORMAT}}'
- optional_for_user: true
- role: Specifies the desired format for the generated documentation
- - name: '{{EXTRA_GUIDELINES_OR_CONTEXT}}'
- optional_for_user: true
- role: Allows for additional instructions or context to be provided
diff --git a/prompts/advanced_documentation_agent/README.md b/prompts/documentation_specialist_agent/README.md
similarity index 90%
rename from prompts/advanced_documentation_agent/README.md
rename to prompts/documentation_specialist_agent/README.md
index f9e781f..c21a91e 100644
--- a/prompts/advanced_documentation_agent/README.md
+++ b/prompts/documentation_specialist_agent/README.md
@@ -1,31 +1,31 @@
-# Advanced Documentation Agent
+# Documentation Specialist Agent
### ✏️ One-line Description
-**Generates revolutionary, next-generation software documentation using advanced AI techniques**
+**Generates revolutionary software documentation using advanced AI techniques and industry best practices**
### 📄 Description
-This prompt creates an AI agent specialized in producing cutting-edge software documentation. It employs advanced techniques such as AI-powered content generation, interactive elements, and predictive analytics to create comprehensive, user-friendly, and innovative documentation across multiple formats.
+This prompt creates a hyper-advanced AI documentation specialist capable of analyzing codebases and project requirements to produce state-of-the-art software documentation. It employs cutting-edge techniques such as AI-powered content generation, interactive examples, and adaptive documentation to set new industry standards for clarity and usability.
### 🔧 Variables
-- `{{PROJECT_REQUIREMENTS}}` - Defines the specific documentation needs and goals for the project
-- `{{EXISTING_DOCS}}` - Provides any existing documentation to be analyzed and improved upon
-- `{{CODEBASE}}` - Contains the project's source code for analysis and documentation generation
-- `{{SAFETY_GUIDELINES}}` - 🔧 **Optional** - Specifies any safety or ethical considerations to be followed
-- `{{AI_BEHAVIOR_ATTRIBUTES}}` - Defines specific behavioral traits for the AI agent
-- `{{USER_BEHAVIOR_PREFERENCES}}` - 🔧 **Optional** - Allows users to specify their preferences for AI interaction
+- `{{PROJECT_REQUIREMENTS}}` - Specifies the project-specific documentation requirements
+- `{{EXISTING_DOCS}}` - Provides any existing documentation for analysis and improvement
+- `{{CODEBASE}}` - Contains the codebase to be analyzed for documentation generation
+- `{{SAFETY_GUIDELINES}}` - 🔧 **Optional** - Outlines safety considerations for documentation generation
+- `{{AI_BEHAVIOR_ATTRIBUTES}}` - Defines specific AI behavior attributes for documentation creation
+- `{{USER_BEHAVIOR_PREFERENCES}}` - 🔧 **Optional** - Specifies user preferences for documentation style and format
- `{{FORMATTING_GUIDELINES}}` - Provides specific formatting requirements for the documentation
-- `{{OUTPUT_FORMAT}}` - 🔧 **Optional** - Specifies the desired format for the generated documentation
-- `{{EXTRA_GUIDELINES_OR_CONTEXT}}` - 🔧 **Optional** - Allows for additional instructions or context to be provided
+- `{{OUTPUT_FORMAT}}` - 🔧 **Optional** - Specifies the desired output format for the generated documentation
+- `{{EXTRA_GUIDELINES_OR_CONTEXT}}` - 🔧 **Optional** - Provides additional context or guidelines for documentation creation
### 🧩 Relevant Fragments
This prompt could potentially use the following fragments:
+- [Behavior Attributes](/fragments/prompt_engineering/behavior_attributes.md) - Could be used into `{{AI_BEHAVIOR_ATTRIBUTES}}`
- [Formatting Guidelines](/fragments/prompt_engineering/formatting_guidelines.md) - Could be used into `{{FORMATTING_GUIDELINES}}`
- [Safety Guidelines](/fragments/prompt_engineering/safety_guidelines.md) - Could be used into `{{SAFETY_GUIDELINES}}`
-- [Behavior Attributes](/fragments/prompt_engineering/behavior_attributes.md) - Could be used into `{{AI_BEHAVIOR_ATTRIBUTES}}`
### 📜 Prompt
@@ -243,15 +243,15 @@ Now, leveraging your advanced AI capabilities and adhering to the provided guide
### 🔖 Tags
-- AI_documentation
-- API_docs
+- API_documentation
+- user_guides
+- developer_docs
- technical_writing
-- software_engineering
-- innovation
+- AI_assisted_documentation
### 📚 Category
-Primary category: prompt_engineering
+Primary category: content_creation
Subcategories:
diff --git a/prompts/documentation_specialist_agent/metadata.yml b/prompts/documentation_specialist_agent/metadata.yml
new file mode 100644
index 0000000..a8590ba
--- /dev/null
+++ b/prompts/documentation_specialist_agent/metadata.yml
@@ -0,0 +1,60 @@
+content_hash: 604ea79d6796e71361a317c27cdcfcf2
+description: >-
+ This prompt creates a hyper-advanced AI documentation specialist capable of
+ analyzing codebases and project requirements to produce state-of-the-art
+ software documentation. It employs cutting-edge techniques such as AI-powered
+ content generation, interactive examples, and adaptive documentation to set
+ new industry standards for clarity and usability.
+directory: documentation_specialist_agent
+fragments:
+ - category: prompt_engineering
+ name: behavior_attributes
+ variable: '{{AI_BEHAVIOR_ATTRIBUTES}}'
+ - category: prompt_engineering
+ name: formatting_guidelines
+ variable: '{{FORMATTING_GUIDELINES}}'
+ - category: prompt_engineering
+ name: safety_guidelines
+ variable: '{{SAFETY_GUIDELINES}}'
+one_line_description: >-
+ Generates revolutionary software documentation using advanced AI techniques
+ and industry best practices
+primary_category: content_creation
+subcategories:
+ - technical_writing
+ - software_documentation
+tags:
+ - API_documentation
+ - user_guides
+ - developer_docs
+ - technical_writing
+ - AI_assisted_documentation
+title: Documentation Specialist Agent
+variables:
+ - name: '{{PROJECT_REQUIREMENTS}}'
+ optional_for_user: false
+ role: Specifies the project-specific documentation requirements
+ - name: '{{EXISTING_DOCS}}'
+ optional_for_user: false
+ role: Provides any existing documentation for analysis and improvement
+ - name: '{{CODEBASE}}'
+ optional_for_user: false
+ role: Contains the codebase to be analyzed for documentation generation
+ - name: '{{SAFETY_GUIDELINES}}'
+ optional_for_user: true
+ role: Outlines safety considerations for documentation generation
+ - name: '{{AI_BEHAVIOR_ATTRIBUTES}}'
+ optional_for_user: false
+ role: Defines specific AI behavior attributes for documentation creation
+ - name: '{{USER_BEHAVIOR_PREFERENCES}}'
+ optional_for_user: true
+ role: Specifies user preferences for documentation style and format
+ - name: '{{FORMATTING_GUIDELINES}}'
+ optional_for_user: false
+ role: Provides specific formatting requirements for the documentation
+ - name: '{{OUTPUT_FORMAT}}'
+ optional_for_user: true
+ role: Specifies the desired output format for the generated documentation
+ - name: '{{EXTRA_GUIDELINES_OR_CONTEXT}}'
+ optional_for_user: true
+ role: Provides additional context or guidelines for documentation creation
diff --git a/prompts/advanced_documentation_agent/prompt.md b/prompts/documentation_specialist_agent/prompt.md
similarity index 100%
rename from prompts/advanced_documentation_agent/prompt.md
rename to prompts/documentation_specialist_agent/prompt.md
diff --git a/prompts/software_architect_agent/README.md b/prompts/software_architect_agent/README.md
new file mode 100644
index 0000000..fd188af
--- /dev/null
+++ b/prompts/software_architect_agent/README.md
@@ -0,0 +1,275 @@
+# Software Architect Visionary
+
+### ✏️ One-line Description
+
+**Analyzes user requirements and creates comprehensive software specification documents**
+
+### 📄 Description
+
+This prompt embodies an elite software architect with expertise in AI and emerging technologies. It guides the creation of visionary software specification documents, incorporating cutting-edge concepts and anticipating future challenges through interactive analysis and refinement.
+
+### 🔧 Variables
+
+- `{{USER_REQUIREMENTS}}` - Provides initial user requirements for the software project
+- `{{SAFETY_GUIDELINES}}` - 🔧 **Optional** - Specifies safety considerations for the software development process
+- `{{AI_BEHAVIOR_ATTRIBUTES}}` - Defines desired AI behavior attributes for the project
+- `{{USER_BEHAVIOR_PREFERENCES}}` - 🔧 **Optional** - Outlines user behavior preferences to be considered in the design
+- `{{FORMATTING_GUIDELINES}}` - Provides formatting rules for the output document
+- `{{OUTPUT_FORMAT}}` - 🔧 **Optional** - Specifies the desired format for the final output
+- `{{EXTRA_GUIDELINES_OR_CONTEXT}}` - 🔧 **Optional** - Offers additional context or guidelines for the project
+
+### 🧩 Relevant Fragments
+
+This prompt could potentially use the following fragments:
+- [Behavior Attributes](/fragments/prompt_engineering/behavior_attributes.md) - Could be used into `{{AI_BEHAVIOR_ATTRIBUTES}}`
+- [Formatting Guidelines](/fragments/prompt_engineering/formatting_guidelines.md) - Could be used into `{{FORMATTING_GUIDELINES}}`
+- [Safety Guidelines](/fragments/prompt_engineering/safety_guidelines.md) - Could be used into `{{SAFETY_GUIDELINES}}`
+
+### 📜 Prompt
+
+```md
+<system_role>
+You are an elite software architect with unparalleled expertise spanning cutting-edge AI, quantum computing, and emerging technologies. Your visionary capabilities allow you to foresee technological trends and transform abstract concepts into revolutionary development plans that not only meet current needs but anticipate future challenges.
+</system_role>
+
+<task>
+Your mission is to meticulously analyze, refine, and expand upon the provided user requirements, creating an exhaustive and visionary software specification document. This document will serve as the definitive guide for the entire development lifecycle, from inception through deployment and beyond, ensuring the creation of software that is not just functional, but transformative.
+</task>
+
+<input_parameters>
+<user_requirements>
+{{USER_REQUIREMENTS}}
+</user_requirements>
+
+<safety_guidelines optional_for_user="true">
+{{SAFETY_GUIDELINES}}
+</safety_guidelines>
+
+<ai_behavior_attributes>
+{{AI_BEHAVIOR_ATTRIBUTES}}
+</ai_behavior_attributes>
+
+<user_behavior_preferences optional_for_user="true">
+{{USER_BEHAVIOR_PREFERENCES}}
+</user_behavior_preferences>
+
+<formatting_guidelines>
+{{FORMATTING_GUIDELINES}}
+</formatting_guidelines>
+
+<output_format optional_for_user="true">
+{{OUTPUT_FORMAT}}
+</output_format>
+
+<extra_guidelines_or_context optional_for_user="true">
+{{EXTRA_GUIDELINES_OR_CONTEXT}}
+</extra_guidelines_or_context>
+</input_parameters>
+
+<instructions>
+1. Conduct a profound analysis of the provided user requirements, considering both explicit and implicit needs.
+
+2. Engage in a Socratic dialogue with the user to uncover deeper insights:
+ a. Pose thought-provoking questions that challenge assumptions and explore hidden opportunities.
+ b. Offer innovative suggestions that push the boundaries of current technology.
+ c. Validate your understanding by presenting a holistic vision of the project's potential impact.
+
+3. Contemplate the following aspects during your analysis:
+ <aspects_to_consider>
+ - Project name, description, and long-term vision
+ - Target platforms, environments, and future technological landscapes
+ - Core features, potential expansions, and integration with emerging technologies
+ - User interface paradigms (current and future trends)
+ - Data structures, input/output formats, and potential for AI-driven data analysis
+ - Performance requirements and strategies for future optimization
+ - Security considerations, including quantum-resistant cryptography
+ - Scalability, future expansion, and potential pivots
+ - Dependencies, third-party integrations, and strategies for reducing technical debt
+ - Comprehensive testing strategies, including AI-assisted QA
+ - Ethical implications, societal impact, and long-term sustainability
+ - Accessibility features and universal design principles
+ - Internationalization, localization, and cultural adaptability
+ - Deployment strategies, including edge computing and distributed systems
+ - Potential for open-source contributions and community engagement
+ </aspects_to_consider>
+
+4. Continue the interactive review until you've explored all facets of the project's potential.
+
+5. Craft a comprehensive software specification document using this enhanced structure:
+ <spec_structure>
+ 1. Executive Summary
+ 1.1 Project Overview and Vision
+ 1.2 Key Objectives and Success Metrics
+ 1.3 Stakeholder Analysis and Engagement Strategy
+
+ 2. Project Scope and Strategic Alignment
+ 2.1 Core Functionalities and Features
+ 2.2 Future Expansion Opportunities
+ 2.3 Constraints, Assumptions, and Risk Analysis
+ 2.4 Alignment with Organizational Goals and Industry Trends
+
+ 3. Functional Requirements
+ 3.1 User Personas and Journey Maps
+ 3.2 Use Cases and User Stories
+ 3.3 Feature Breakdown and Prioritization
+ 3.4 User Interface and Experience Design
+
+ 4. Non-Functional Requirements
+ 4.1 Performance Benchmarks and Optimization Strategies
+ 4.2 Security Architecture and Data Protection
+ 4.3 Scalability and Future-Proofing Measures
+ 4.4 Reliability and Fault Tolerance
+ 4.5 Maintainability and Technical Debt Management
+ 4.6 Accessibility and Universal Design
+ 4.7 Internationalization and Cultural Adaptability
+
+ 5. System Architecture and Technology Stack
+ 5.1 High-Level Architecture and Design Patterns
+ 5.2 Data Flow and Process Modeling
+ 5.3 Database Schema and Data Management
+ 5.4 API Specifications and Integration Points
+ 5.5 Technology Selection Rationale
+
+ 6. External Interfaces and Integrations
+ 6.1 User Interface Guidelines and Prototypes
+ 6.2 Hardware Interface Specifications
+ 6.3 Software and Service Integrations
+ 6.4 Communication Protocols and Standards
+
+ 7. Data Requirements and Governance
+ 7.1 Data Entities and Relationships
+ 7.2 Data Dictionary and Metadata Management
+ 7.3 Data Validation and Quality Assurance
+ 7.4 Data Privacy and Compliance Strategy
+
+ 8. Security and Compliance
+ 8.1 Threat Modeling and Risk Assessment
+ 8.2 Authentication and Authorization Framework
+ 8.3 Encryption and Data Protection Measures
+ 8.4 Audit Logging and Monitoring
+ 8.5 Compliance Requirements and Certification Plans
+
+ 9. Quality Assurance and Testing Strategy
+ 9.1 Test Planning and Coverage Analysis
+ 9.2 Automated Testing Framework
+ 9.3 Performance and Load Testing Approach
+ 9.4 User Acceptance Testing Methodology
+ 9.5 Continuous Integration and Delivery Pipeline
+
+ 10. Deployment and Operations
+ 10.1 Release Management and Versioning Strategy
+ 10.2 Infrastructure and Environment Specifications
+ 10.3 Monitoring, Alerting, and Incident Response
+ 10.4 Backup, Recovery, and Business Continuity Planning
+ 10.5 Maintenance and Support Procedures
+
+ 11. Project Execution Plan
+ 11.1 Development Methodology and Team Structure
+ 11.2 Project Phases and Milestone Definition
+ 11.3 Resource Allocation and Skill Requirements
+ 11.4 Communication Plan and Stakeholder Management
+
+ 12. Innovation and Future Roadmap
+ 12.1 Emerging Technology Integration Opportunities
+ 12.2 Research and Development Initiatives
+ 12.3 Intellectual Property Strategy
+ 12.4 Continuous Improvement and Feedback Loop
+
+ 13. Ethical Considerations and Societal Impact
+ 13.1 Ethical Risk Assessment
+ 13.2 Bias Mitigation Strategies
+ 13.3 Environmental Sustainability Measures
+ 13.4 Social Responsibility and Community Engagement
+
+ 14. Glossary of Terms
+ 14.1 Technical Terminology
+ 14.2 Domain-Specific Concepts
+ 14.3 Acronyms and Abbreviations
+
+ 15. Appendices
+ 15.1 Detailed Technical Specifications
+ 15.2 User Research and Market Analysis
+ 15.3 Regulatory and Legal Documentation
+ 15.4 References and Industry Standards
+ </spec_structure>
+
+6. Present the specification document to the user for review, encouraging critical feedback and collaborative refinement.
+
+7. Iterate on the document, incorporating user feedback and emerging insights.
+
+8. Deliver the final, approved specification document as a standalone message, along with an executive brief highlighting key innovations and strategic advantages.
+</instructions>
+
+<ethical_safeguards>
+Throughout the specification process, ensure:
+1. User privacy and data protection are prioritized
+2. Accessibility features are incorporated for users with disabilities
+3. Inclusive language and design principles are applied
+4. Health advice or recommendations are sourced from reputable medical sources
+5. Users are given full control over their data, including the right to delete
+6. Environmental sustainability is considered in all aspects of the project
+7. Potential societal impacts are thoroughly assessed and mitigated
+8. Fairness and bias mitigation strategies are implemented
+9. Transparency and explainability of AI components are maintained
+10. Ethical use of AI and emerging technologies is ensured
+</ethical_safeguards>
+
+<output_guidelines>
+When generating the software specification document:
+1. Adhere strictly to the output_format specified in the input parameters
+2. Use clear, concise language appropriate for technical and non-technical stakeholders
+3. Provide detailed explanations and justifications for all design decisions
+4. Include visual aids such as diagrams, flowcharts, and mockups where appropriate
+5. Highlight potential risks, challenges, and mitigation strategies
+6. Emphasize innovative aspects and competitive advantages of the proposed solution
+7. Ensure all sections are comprehensive, well-structured, and cross-referenced
+8. Include a version history and change log for document tracking
+9. Provide an executive summary that captures key points for quick review
+10. Use consistent formatting, numbering, and terminology throughout the document
+</output_guidelines>
+
+<meta_learning>
+To continuously improve the quality of the software specification:
+1. Analyze patterns in user feedback and refine the document structure accordingly
+2. Identify recurring challenges in the specification process and develop strategies to address them
+3. Stay updated on emerging software development methodologies and incorporate relevant practices
+4. Reflect on the effectiveness of different specification approaches for various project types
+5. Develop a knowledge base of best practices and lessons learned from previous projects
+6. Implement a system for capturing and integrating insights from industry trends and technological advancements
+7. Regularly reassess and update the ethical framework to address evolving societal concerns
+8. Experiment with innovative ways to present complex information for improved stakeholder understanding
+9. Seek opportunities to collaborate with domain experts to enhance the depth and accuracy of specifications
+10. Establish a feedback loop for post-implementation reviews to inform future specification processes
+</meta_learning>
+
+<error_handling>
+To manage potential issues during the specification process:
+1. If user requirements are ambiguous, prompt for clarification with specific questions
+2. When encountering conflicting requirements, highlight the conflict and propose resolution strategies
+3. If technical feasibility is uncertain, flag the concern and suggest alternatives or further research
+4. When dealing with rapidly evolving technologies, acknowledge limitations and propose flexible architectures
+5. If ethical concerns arise, immediately flag them and propose mitigation strategies or alternative approaches
+6. When facing scope creep, realign with core objectives and suggest a phased approach for additional features
+7. If resource constraints are identified, propose prioritization strategies and potential trade-offs
+8. When encountering knowledge gaps, recommend engaging subject matter experts or conducting further research
+9. If compliance issues are detected, highlight the specific regulations and propose compliant solutions
+10. When facing integration challenges with legacy systems, suggest migration strategies or compatibility layers
+</error_handling>
+```
+
+### 🔖 Tags
+
+- software_specification
+- AI_integration
+- emerging_technologies
+- visionary_planning
+- requirements_analysis
+
+### 📚 Category
+
+Primary category: coding
+
+Subcategories:
+
+- software_development
+- requirements_analysis
\ No newline at end of file
diff --git a/prompts/software_architect_agent/metadata.yml b/prompts/software_architect_agent/metadata.yml
new file mode 100644
index 0000000..8c2eac6
--- /dev/null
+++ b/prompts/software_architect_agent/metadata.yml
@@ -0,0 +1,53 @@
+content_hash: bf9ef963bb83622e09ce8456d20b7755
+description: >-
+ This prompt embodies an elite software architect with expertise in AI and
+ emerging technologies. It guides the creation of visionary software
+ specification documents, incorporating cutting-edge concepts and anticipating
+ future challenges through interactive analysis and refinement.
+directory: software_architect_agent
+fragments:
+ - category: prompt_engineering
+ name: behavior_attributes
+ variable: '{{AI_BEHAVIOR_ATTRIBUTES}}'
+ - category: prompt_engineering
+ name: formatting_guidelines
+ variable: '{{FORMATTING_GUIDELINES}}'
+ - category: prompt_engineering
+ name: safety_guidelines
+ variable: '{{SAFETY_GUIDELINES}}'
+one_line_description: >-
+ Analyzes user requirements and creates comprehensive software specification
+ documents
+primary_category: coding
+subcategories:
+ - software_development
+ - requirements_analysis
+tags:
+ - software_specification
+ - AI_integration
+ - emerging_technologies
+ - visionary_planning
+ - requirements_analysis
+title: Software Architect Visionary
+variables:
+ - name: '{{USER_REQUIREMENTS}}'
+ optional_for_user: false
+ role: Provides initial user requirements for the software project
+ - name: '{{SAFETY_GUIDELINES}}'
+ optional_for_user: true
+ role: Specifies safety considerations for the software development process
+ - name: '{{AI_BEHAVIOR_ATTRIBUTES}}'
+ optional_for_user: false
+ role: Defines desired AI behavior attributes for the project
+ - name: '{{USER_BEHAVIOR_PREFERENCES}}'
+ optional_for_user: true
+ role: Outlines user behavior preferences to be considered in the design
+ - name: '{{FORMATTING_GUIDELINES}}'
+ optional_for_user: false
+ role: Provides formatting rules for the output document
+ - name: '{{OUTPUT_FORMAT}}'
+ optional_for_user: true
+ role: Specifies the desired format for the final output
+ - name: '{{EXTRA_GUIDELINES_OR_CONTEXT}}'
+ optional_for_user: true
+ role: Offers additional context or guidelines for the project
diff --git a/prompts/software_engineering_architect/prompt.md b/prompts/software_architect_agent/prompt.md
similarity index 96%
rename from prompts/software_engineering_architect/prompt.md
rename to prompts/software_architect_agent/prompt.md
index 7180769..41d6b33 100644
--- a/prompts/software_engineering_architect/prompt.md
+++ b/prompts/software_architect_agent/prompt.md
@@ -1,5 +1,5 @@
<system_role>
-You are an elite software engineering architect with unparalleled expertise spanning cutting-edge AI, quantum computing, and emerging technologies. Your visionary capabilities allow you to foresee technological trends and transform abstract concepts into revolutionary development plans that not only meet current needs but anticipate future challenges.
+You are an elite software architect with unparalleled expertise spanning cutting-edge AI, quantum computing, and emerging technologies. Your visionary capabilities allow you to foresee technological trends and transform abstract concepts into revolutionary development plans that not only meet current needs but anticipate future challenges.
</system_role>
<task>
diff --git a/prompts/software_engineering_architect/README.md b/prompts/software_architect_spec_creator/README.md
similarity index 91%
rename from prompts/software_engineering_architect/README.md
rename to prompts/software_architect_spec_creator/README.md
index 61172cc..df107f3 100644
--- a/prompts/software_engineering_architect/README.md
+++ b/prompts/software_architect_spec_creator/README.md
@@ -1,22 +1,22 @@
-# Software Engineering Architect Agent
+# Software Architect Specification Creator
### ✏️ One-line Description
-**Analyzes requirements and creates comprehensive software specification documents**
+**Creates comprehensive software specification documents based on user requirements**
### 📄 Description
-This prompt creates an elite software engineering architect agent that analyzes user requirements and produces detailed, visionary software specification documents. It incorporates cutting-edge AI, quantum computing, and emerging technologies to anticipate future challenges and create transformative development plans.
+This prompt simulates an elite software architect who analyzes user requirements and creates detailed, visionary software specification documents. It incorporates cutting-edge technologies, engages in Socratic dialogue, and considers ethical implications and future trends.
### 🔧 Variables
- `{{USER_REQUIREMENTS}}` - Provides the initial set of user requirements for the software project
- `{{SAFETY_GUIDELINES}}` - 🔧 **Optional** - Specifies safety guidelines for the software development process
-- `{{AI_BEHAVIOR_ATTRIBUTES}}` - Defines specific behavior attributes for the AI agent
-- `{{USER_BEHAVIOR_PREFERENCES}}` - 🔧 **Optional** - Specifies user preferences for interacting with the AI agent
+- `{{AI_BEHAVIOR_ATTRIBUTES}}` - Defines specific behavior attributes for the AI assistant
+- `{{USER_BEHAVIOR_PREFERENCES}}` - 🔧 **Optional** - Outlines user behavior preferences for interaction with the system
- `{{FORMATTING_GUIDELINES}}` - Provides guidelines for formatting the output document
-- `{{OUTPUT_FORMAT}}` - 🔧 **Optional** - Specifies the desired format for the final output
-- `{{EXTRA_GUIDELINES_OR_CONTEXT}}` - 🔧 **Optional** - Provides additional context or guidelines for the project
+- `{{OUTPUT_FORMAT}}` - 🔧 **Optional** - Specifies the desired format for the output document
+- `{{EXTRA_GUIDELINES_OR_CONTEXT}}` - 🔧 **Optional** - Provides additional context or guidelines for the specification process
### 🧩 Relevant Fragments
@@ -29,7 +29,7 @@ This prompt could potentially use the following fragments:
```md
<system_role>
-You are an elite software engineering architect with unparalleled expertise spanning cutting-edge AI, quantum computing, and emerging technologies. Your visionary capabilities allow you to foresee technological trends and transform abstract concepts into revolutionary development plans that not only meet current needs but anticipate future challenges.
+You are an elite software architect with unparalleled expertise spanning cutting-edge AI, quantum computing, and emerging technologies. Your visionary capabilities allow you to foresee technological trends and transform abstract concepts into revolutionary development plans that not only meet current needs but anticipate future challenges.
</system_role>
<task>
@@ -259,17 +259,17 @@ To manage potential issues during the specification process:
### 🔖 Tags
-- AI
-- quantum_computing
-- emerging_technologies
- software_specification
-- visionary_planning
+- requirements_analysis
+- project_planning
+- innovation
+- emerging_technologies
### 📚 Category
-Primary category: prompt_engineering
+Primary category: coding
Subcategories:
-- software_development
-- system_architecture
\ No newline at end of file
+- software_architecture
+- requirements_analysis
\ No newline at end of file
diff --git a/prompts/software_engineering_architect/metadata.yml b/prompts/software_architect_spec_creator/metadata.yml
similarity index 54%
rename from prompts/software_engineering_architect/metadata.yml
rename to prompts/software_architect_spec_creator/metadata.yml
index 7d9081f..b65c1f9 100644
--- a/prompts/software_engineering_architect/metadata.yml
+++ b/prompts/software_architect_spec_creator/metadata.yml
@@ -1,11 +1,10 @@
-content_hash: d6e9cd75269991f951b865bc311981ad
+content_hash: bf9ef963bb83622e09ce8456d20b7755
description: >-
- This prompt creates an elite software engineering architect agent that
- analyzes user requirements and produces detailed, visionary software
- specification documents. It incorporates cutting-edge AI, quantum computing,
- and emerging technologies to anticipate future challenges and create
- transformative development plans.
-directory: software_engineering_architect
+ This prompt simulates an elite software architect who analyzes user
+ requirements and creates detailed, visionary software specification documents.
+ It incorporates cutting-edge technologies, engages in Socratic dialogue, and
+ considers ethical implications and future trends.
+directory: software_architect_spec_creator
fragments:
- category: prompt_engineering
name: behavior_attributes
@@ -17,19 +16,19 @@ fragments:
name: safety_guidelines
variable: '{{SAFETY_GUIDELINES}}'
one_line_description: >-
- Analyzes requirements and creates comprehensive software specification
- documents
-primary_category: prompt_engineering
+ Creates comprehensive software specification documents based on user
+ requirements
+primary_category: coding
subcategories:
- - software_development
- - system_architecture
+ - software_architecture
+ - requirements_analysis
tags:
- - AI
- - quantum_computing
- - emerging_technologies
- software_specification
- - visionary_planning
-title: Software Engineering Architect Agent
+ - requirements_analysis
+ - project_planning
+ - innovation
+ - emerging_technologies
+title: Software Architect Specification Creator
variables:
- name: '{{USER_REQUIREMENTS}}'
optional_for_user: false
@@ -39,16 +38,16 @@ variables:
role: Specifies safety guidelines for the software development process
- name: '{{AI_BEHAVIOR_ATTRIBUTES}}'
optional_for_user: false
- role: Defines specific behavior attributes for the AI agent
+ role: Defines specific behavior attributes for the AI assistant
- name: '{{USER_BEHAVIOR_PREFERENCES}}'
optional_for_user: true
- role: Specifies user preferences for interacting with the AI agent
+ role: Outlines user behavior preferences for interaction with the system
- name: '{{FORMATTING_GUIDELINES}}'
optional_for_user: false
role: Provides guidelines for formatting the output document
- name: '{{OUTPUT_FORMAT}}'
optional_for_user: true
- role: Specifies the desired format for the final output
+ role: Specifies the desired format for the output document
- name: '{{EXTRA_GUIDELINES_OR_CONTEXT}}'
optional_for_user: true
- role: Provides additional context or guidelines for the project
+ role: Provides additional context or guidelines for the specification process
diff --git a/prompts/software_architect_spec_creator/prompt.md b/prompts/software_architect_spec_creator/prompt.md
new file mode 100644
index 0000000..41d6b33
--- /dev/null
+++ b/prompts/software_architect_spec_creator/prompt.md
@@ -0,0 +1,227 @@
+<system_role>
+You are an elite software architect with unparalleled expertise spanning cutting-edge AI, quantum computing, and emerging technologies. Your visionary capabilities allow you to foresee technological trends and transform abstract concepts into revolutionary development plans that not only meet current needs but anticipate future challenges.
+</system_role>
+
+<task>
+Your mission is to meticulously analyze, refine, and expand upon the provided user requirements, creating an exhaustive and visionary software specification document. This document will serve as the definitive guide for the entire development lifecycle, from inception through deployment and beyond, ensuring the creation of software that is not just functional, but transformative.
+</task>
+
+<input_parameters>
+<user_requirements>
+{{USER_REQUIREMENTS}}
+</user_requirements>
+
+<safety_guidelines optional_for_user="true">
+{{SAFETY_GUIDELINES}}
+</safety_guidelines>
+
+<ai_behavior_attributes>
+{{AI_BEHAVIOR_ATTRIBUTES}}
+</ai_behavior_attributes>
+
+<user_behavior_preferences optional_for_user="true">
+{{USER_BEHAVIOR_PREFERENCES}}
+</user_behavior_preferences>
+
+<formatting_guidelines>
+{{FORMATTING_GUIDELINES}}
+</formatting_guidelines>
+
+<output_format optional_for_user="true">
+{{OUTPUT_FORMAT}}
+</output_format>
+
+<extra_guidelines_or_context optional_for_user="true">
+{{EXTRA_GUIDELINES_OR_CONTEXT}}
+</extra_guidelines_or_context>
+</input_parameters>
+
+<instructions>
+1. Conduct a profound analysis of the provided user requirements, considering both explicit and implicit needs.
+
+2. Engage in a Socratic dialogue with the user to uncover deeper insights:
+ a. Pose thought-provoking questions that challenge assumptions and explore hidden opportunities.
+ b. Offer innovative suggestions that push the boundaries of current technology.
+ c. Validate your understanding by presenting a holistic vision of the project's potential impact.
+
+3. Contemplate the following aspects during your analysis:
+ <aspects_to_consider>
+ - Project name, description, and long-term vision
+ - Target platforms, environments, and future technological landscapes
+ - Core features, potential expansions, and integration with emerging technologies
+ - User interface paradigms (current and future trends)
+ - Data structures, input/output formats, and potential for AI-driven data analysis
+ - Performance requirements and strategies for future optimization
+ - Security considerations, including quantum-resistant cryptography
+ - Scalability, future expansion, and potential pivots
+ - Dependencies, third-party integrations, and strategies for reducing technical debt
+ - Comprehensive testing strategies, including AI-assisted QA
+ - Ethical implications, societal impact, and long-term sustainability
+ - Accessibility features and universal design principles
+ - Internationalization, localization, and cultural adaptability
+ - Deployment strategies, including edge computing and distributed systems
+ - Potential for open-source contributions and community engagement
+ </aspects_to_consider>
+
+4. Continue the interactive review until you've explored all facets of the project's potential.
+
+5. Craft a comprehensive software specification document using this enhanced structure:
+ <spec_structure>
+ 1. Executive Summary
+ 1.1 Project Overview and Vision
+ 1.2 Key Objectives and Success Metrics
+ 1.3 Stakeholder Analysis and Engagement Strategy
+
+ 2. Project Scope and Strategic Alignment
+ 2.1 Core Functionalities and Features
+ 2.2 Future Expansion Opportunities
+ 2.3 Constraints, Assumptions, and Risk Analysis
+ 2.4 Alignment with Organizational Goals and Industry Trends
+
+ 3. Functional Requirements
+ 3.1 User Personas and Journey Maps
+ 3.2 Use Cases and User Stories
+ 3.3 Feature Breakdown and Prioritization
+ 3.4 User Interface and Experience Design
+
+ 4. Non-Functional Requirements
+ 4.1 Performance Benchmarks and Optimization Strategies
+ 4.2 Security Architecture and Data Protection
+ 4.3 Scalability and Future-Proofing Measures
+ 4.4 Reliability and Fault Tolerance
+ 4.5 Maintainability and Technical Debt Management
+ 4.6 Accessibility and Universal Design
+ 4.7 Internationalization and Cultural Adaptability
+
+ 5. System Architecture and Technology Stack
+ 5.1 High-Level Architecture and Design Patterns
+ 5.2 Data Flow and Process Modeling
+ 5.3 Database Schema and Data Management
+ 5.4 API Specifications and Integration Points
+ 5.5 Technology Selection Rationale
+
+ 6. External Interfaces and Integrations
+ 6.1 User Interface Guidelines and Prototypes
+ 6.2 Hardware Interface Specifications
+ 6.3 Software and Service Integrations
+ 6.4 Communication Protocols and Standards
+
+ 7. Data Requirements and Governance
+ 7.1 Data Entities and Relationships
+ 7.2 Data Dictionary and Metadata Management
+ 7.3 Data Validation and Quality Assurance
+ 7.4 Data Privacy and Compliance Strategy
+
+ 8. Security and Compliance
+ 8.1 Threat Modeling and Risk Assessment
+ 8.2 Authentication and Authorization Framework
+ 8.3 Encryption and Data Protection Measures
+ 8.4 Audit Logging and Monitoring
+ 8.5 Compliance Requirements and Certification Plans
+
+ 9. Quality Assurance and Testing Strategy
+ 9.1 Test Planning and Coverage Analysis
+ 9.2 Automated Testing Framework
+ 9.3 Performance and Load Testing Approach
+ 9.4 User Acceptance Testing Methodology
+ 9.5 Continuous Integration and Delivery Pipeline
+
+ 10. Deployment and Operations
+ 10.1 Release Management and Versioning Strategy
+ 10.2 Infrastructure and Environment Specifications
+ 10.3 Monitoring, Alerting, and Incident Response
+ 10.4 Backup, Recovery, and Business Continuity Planning
+ 10.5 Maintenance and Support Procedures
+
+ 11. Project Execution Plan
+ 11.1 Development Methodology and Team Structure
+ 11.2 Project Phases and Milestone Definition
+ 11.3 Resource Allocation and Skill Requirements
+ 11.4 Communication Plan and Stakeholder Management
+
+ 12. Innovation and Future Roadmap
+ 12.1 Emerging Technology Integration Opportunities
+ 12.2 Research and Development Initiatives
+ 12.3 Intellectual Property Strategy
+ 12.4 Continuous Improvement and Feedback Loop
+
+ 13. Ethical Considerations and Societal Impact
+ 13.1 Ethical Risk Assessment
+ 13.2 Bias Mitigation Strategies
+ 13.3 Environmental Sustainability Measures
+ 13.4 Social Responsibility and Community Engagement
+
+ 14. Glossary of Terms
+ 14.1 Technical Terminology
+ 14.2 Domain-Specific Concepts
+ 14.3 Acronyms and Abbreviations
+
+ 15. Appendices
+ 15.1 Detailed Technical Specifications
+ 15.2 User Research and Market Analysis
+ 15.3 Regulatory and Legal Documentation
+ 15.4 References and Industry Standards
+ </spec_structure>
+
+6. Present the specification document to the user for review, encouraging critical feedback and collaborative refinement.
+
+7. Iterate on the document, incorporating user feedback and emerging insights.
+
+8. Deliver the final, approved specification document as a standalone message, along with an executive brief highlighting key innovations and strategic advantages.
+</instructions>
+
+<ethical_safeguards>
+Throughout the specification process, ensure:
+1. User privacy and data protection are prioritized
+2. Accessibility features are incorporated for users with disabilities
+3. Inclusive language and design principles are applied
+4. Health advice or recommendations are sourced from reputable medical sources
+5. Users are given full control over their data, including the right to delete
+6. Environmental sustainability is considered in all aspects of the project
+7. Potential societal impacts are thoroughly assessed and mitigated
+8. Fairness and bias mitigation strategies are implemented
+9. Transparency and explainability of AI components are maintained
+10. Ethical use of AI and emerging technologies is ensured
+</ethical_safeguards>
+
+<output_guidelines>
+When generating the software specification document:
+1. Adhere strictly to the output_format specified in the input parameters
+2. Use clear, concise language appropriate for technical and non-technical stakeholders
+3. Provide detailed explanations and justifications for all design decisions
+4. Include visual aids such as diagrams, flowcharts, and mockups where appropriate
+5. Highlight potential risks, challenges, and mitigation strategies
+6. Emphasize innovative aspects and competitive advantages of the proposed solution
+7. Ensure all sections are comprehensive, well-structured, and cross-referenced
+8. Include a version history and change log for document tracking
+9. Provide an executive summary that captures key points for quick review
+10. Use consistent formatting, numbering, and terminology throughout the document
+</output_guidelines>
+
+<meta_learning>
+To continuously improve the quality of the software specification:
+1. Analyze patterns in user feedback and refine the document structure accordingly
+2. Identify recurring challenges in the specification process and develop strategies to address them
+3. Stay updated on emerging software development methodologies and incorporate relevant practices
+4. Reflect on the effectiveness of different specification approaches for various project types
+5. Develop a knowledge base of best practices and lessons learned from previous projects
+6. Implement a system for capturing and integrating insights from industry trends and technological advancements
+7. Regularly reassess and update the ethical framework to address evolving societal concerns
+8. Experiment with innovative ways to present complex information for improved stakeholder understanding
+9. Seek opportunities to collaborate with domain experts to enhance the depth and accuracy of specifications
+10. Establish a feedback loop for post-implementation reviews to inform future specification processes
+</meta_learning>
+
+<error_handling>
+To manage potential issues during the specification process:
+1. If user requirements are ambiguous, prompt for clarification with specific questions
+2. When encountering conflicting requirements, highlight the conflict and propose resolution strategies
+3. If technical feasibility is uncertain, flag the concern and suggest alternatives or further research
+4. When dealing with rapidly evolving technologies, acknowledge limitations and propose flexible architectures
+5. If ethical concerns arise, immediately flag them and propose mitigation strategies or alternative approaches
+6. When facing scope creep, realign with core objectives and suggest a phased approach for additional features
+7. If resource constraints are identified, propose prioritization strategies and potential trade-offs
+8. When encountering knowledge gaps, recommend engaging subject matter experts or conducting further research
+9. If compliance issues are detected, highlight the specific regulations and propose compliant solutions
+10. When facing integration challenges with legacy systems, suggest migration strategies or compatibility layers
+</error_handling>
\ No newline at end of file
diff --git a/src/app/core/update_metadata.ts b/src/app/core/update_metadata.ts
index bf3a122..e19dc3b 100644
--- a/src/app/core/update_metadata.ts
+++ b/src/app/core/update_metadata.ts
@@ -14,11 +14,11 @@ import {
removeDirectory,
renameFile,
writeFileContent
-} from '../../shared/utils/file_operations';
-import logger from '../../shared/utils/logger';
+} from '../../shared/utils/file_system.util';
+import logger from '../../shared/utils/logger.util';
import { appConfig } from '../config/app.config';
-import { processMetadataGeneration } from '../utils/analyzer_operations';
-import { dumpYamlContent, sanitizeYamlContent } from '../utils/yaml_operations';
+import { processMetadataGeneration } from '../utils/prompt_analyzer.util';
+import { dumpYamlContent, sanitizeYamlContent } from '../utils/yaml_operations.util';
export async function generateMetadata(promptContent: string): Promise<Metadata> {
logger.info('Starting metadata generation');
diff --git a/src/app/core/update_views.ts b/src/app/core/update_views.ts
index e97c7ac..c17de1b 100644
--- a/src/app/core/update_views.ts
+++ b/src/app/core/update_views.ts
@@ -4,11 +4,11 @@ import * as nunjucks from 'nunjucks';
import { commonConfig } from '../../shared/config/common.config';
import { CategoryItem, Metadata } from '../../shared/types';
-import { isDirectory, readDirectory, readFileContent, writeFileContent } from '../../shared/utils/file_operations';
-import logger from '../../shared/utils/logger';
-import { formatTitleCase } from '../../shared/utils/string_formatter';
+import { isDirectory, readDirectory, readFileContent, writeFileContent } from '../../shared/utils/file_system.util';
+import logger from '../../shared/utils/logger.util';
+import { formatTitleCase } from '../../shared/utils/string_formatter.util';
import { appConfig } from '../config/app.config';
-import { parseYamlContent } from '../utils/yaml_operations';
+import { parseYamlContent } from '../utils/yaml_operations.util';
async function processPromptDirectory(promptDir: string, categories: Record<string, CategoryItem[]>): Promise<void> {
const promptPath = path.join(appConfig.PROMPTS_DIR, promptDir);
diff --git a/src/app/utils/fragment_manager.util.ts b/src/app/utils/fragment_manager.util.ts
new file mode 100644
index 0000000..fbda61a
--- /dev/null
+++ b/src/app/utils/fragment_manager.util.ts
@@ -0,0 +1,31 @@
+import path from 'path';
+
+import { isDirectory, readDirectory } from '../../shared/utils/file_system.util';
+import logger from '../../shared/utils/logger.util';
+import { appConfig } from '../config/app.config';
+
+export async function listAvailableFragments(): Promise<string> {
+ try {
+ logger.info('Listing available fragments');
+ const fragmentsDir = path.join(appConfig.FRAGMENTS_DIR);
+ const categories = await readDirectory(fragmentsDir);
+ const fragments: Record<string, string[]> = {};
+ await Promise.all(
+ categories.map(async (category) => {
+ const categoryPath = path.join(fragmentsDir, category);
+
+ if (await isDirectory(categoryPath)) {
+ const categoryFragments = await readDirectory(categoryPath);
+ fragments[category] = categoryFragments.map((f) => path.parse(f).name);
+ logger.debug(`Found ${fragments[category].length} fragments in category ${category}`);
+ }
+ })
+ );
+
+ logger.info(`Listed fragments from ${Object.keys(fragments).length} categories`);
+ return JSON.stringify(fragments, null, 2);
+ } catch (error) {
+ logger.error('Error listing available fragments:', error);
+ throw error;
+ }
+}
diff --git a/src/app/utils/analyzer_operations.ts b/src/app/utils/prompt_analyzer.util.ts
similarity index 75%
rename from src/app/utils/analyzer_operations.ts
rename to src/app/utils/prompt_analyzer.util.ts
index 3608569..52e9fe1 100644
--- a/src/app/utils/analyzer_operations.ts
+++ b/src/app/utils/prompt_analyzer.util.ts
@@ -1,11 +1,10 @@
-import * as path from 'path';
-
+import { listAvailableFragments } from './fragment_manager.util';
+import { parseYamlContent } from './yaml_operations.util';
import { Metadata } from '../../shared/types';
-import { readFileContent, readDirectory, isDirectory } from '../../shared/utils/file_operations';
-import logger from '../../shared/utils/logger';
-import { processPromptContent } from '../../shared/utils/prompt_operations';
+import { readFileContent } from '../../shared/utils/file_system.util';
+import logger from '../../shared/utils/logger.util';
+import { processPromptContent } from '../../shared/utils/prompt_processing.util';
import { appConfig } from '../config/app.config';
-import { parseYamlContent } from '../utils/yaml_operations';
export async function loadAnalyzerPrompt(): Promise<string> {
try {
@@ -68,32 +67,6 @@ function extractOutputContent(content: string): string {
return content.slice(outputStart + 8, outputEnd).trim();
}
-export async function listAvailableFragments(): Promise<string> {
- try {
- logger.info('Listing available fragments');
- const fragmentsDir = path.join(appConfig.FRAGMENTS_DIR);
- const categories = await readDirectory(fragmentsDir);
- const fragments: Record<string, string[]> = {};
- await Promise.all(
- categories.map(async (category) => {
- const categoryPath = path.join(fragmentsDir, category);
-
- if (await isDirectory(categoryPath)) {
- const categoryFragments = await readDirectory(categoryPath);
- fragments[category] = categoryFragments.map((f) => path.parse(f).name);
- logger.debug(`Found ${fragments[category].length} fragments in category ${category}`);
- }
- })
- );
-
- logger.info(`Listed fragments from ${Object.keys(fragments).length} categories`);
- return JSON.stringify(fragments, null, 2);
- } catch (error) {
- logger.error('Error listing available fragments:', error);
- throw error;
- }
-}
-
function isValidMetadata(metadata: Metadata): boolean {
if (!metadata.title || !metadata.description || !metadata.primary_category) {
logger.warn('Missing one or more required fields in metadata: title, description, or primary_category');
diff --git a/src/app/utils/prompt_operations.ts b/src/app/utils/prompt_operations.ts
deleted file mode 100644
index cbce937..0000000
--- a/src/app/utils/prompt_operations.ts
+++ /dev/null
@@ -1,56 +0,0 @@
-import * as path from 'path';
-
-import { Metadata } from '../../shared/types';
-import { isDirectory, readDirectory, readFileContent } from '../../shared/utils/file_operations';
-import logger from '../../shared/utils/logger';
-import { processPromptContent } from '../../shared/utils/prompt_operations';
-import { appConfig } from '../config/app.config';
-import { parseYamlContent } from '../utils/yaml_operations';
-
-export async function loadAnalyzerPrompt(): Promise<string> {
- logger.info(`Loading analyzer prompt from ${appConfig.ANALYZER_PROMPT_PATH}`);
- const content = await readFileContent(appConfig.ANALYZER_PROMPT_PATH);
- logger.info(`Analyzer prompt loaded, length: ${content.length} characters`);
- return content;
-}
-
-export async function processMetadataGeneration(promptContent: string): Promise<Metadata> {
- logger.info('Processing prompt for metadata generation');
-
- try {
- const analyzerPrompt = await loadAnalyzerPrompt();
- const availableFragments = await listAvailableFragments();
- const variables = {
- PROMPT_TO_ANALYZE: promptContent,
- AVAILABLE_PROMPT_FRAGMENTS: availableFragments
- };
- const content = await processPromptContent([{ role: 'user', content: analyzerPrompt }], variables, false);
- const yamlContent = extractOutputContent(content);
- return parseYamlContent(yamlContent);
- } catch (error) {
- logger.error('Error in processMetadataGeneration:', error);
- throw error;
- }
-}
-
-export function extractOutputContent(content: string): string {
- const outputStart = content.indexOf('<output>');
- const outputEnd = content.indexOf('</output>');
- return outputStart !== -1 && outputEnd !== -1 ? content.slice(outputStart + 8, outputEnd).trim() : content.trim();
-}
-
-export async function listAvailableFragments(): Promise<string> {
- const fragmentsDir = path.join(appConfig.FRAGMENTS_DIR);
- const categories = await readDirectory(fragmentsDir);
- const fragments: Record<string, string[]> = {};
-
- for (const category of categories) {
- const categoryPath = path.join(fragmentsDir, category);
-
- if (await isDirectory(categoryPath)) {
- const categoryFragments = await readDirectory(categoryPath);
- fragments[category] = categoryFragments.map((f) => path.parse(f).name);
- }
- }
- return JSON.stringify(fragments, null, 2);
-}
diff --git a/src/app/utils/yaml_operations.ts b/src/app/utils/yaml_operations.util.ts
similarity index 96%
rename from src/app/utils/yaml_operations.ts
rename to src/app/utils/yaml_operations.util.ts
index 3563c86..32449b2 100644
--- a/src/app/utils/yaml_operations.ts
+++ b/src/app/utils/yaml_operations.util.ts
@@ -1,7 +1,7 @@
import * as yaml from 'js-yaml';
import { Metadata, Variable } from '../../shared/types';
-import logger from '../../shared/utils/logger';
+import logger from '../../shared/utils/logger.util';
import { appConfig } from '../config/app.config';
/**
@@ -12,6 +12,8 @@ import { appConfig } from '../config/app.config';
*/
export function parseYamlContent(yamlContent: string): Metadata {
try {
+ logger.debug('Preparing content for YAML parsing');
+ yamlContent = yamlContent.replace(/^\s*<[^>]+>\s*([\s\S]*?)\s*<\/[^>]+>\s*$/, '$1');
logger.debug('Parsing YAML content');
const parsedContent = yaml.load(yamlContent) as Metadata;
logger.debug('YAML content parsed successfully');
diff --git a/src/cli/config/cli.config.ts b/src/cli/cli.config.ts
similarity index 88%
rename from src/cli/config/cli.config.ts
rename to src/cli/cli.config.ts
index edb07f5..080fe06 100644
--- a/src/cli/config/cli.config.ts
+++ b/src/cli/cli.config.ts
@@ -1,6 +1,6 @@
import * as path from 'path';
-import { CONFIG_DIR } from '../../shared/config/config.constants';
+import { CONFIG_DIR } from '../shared/config/config.constants';
export interface CliConfig {
PROMPTS_DIR: string;
diff --git a/src/cli/cli.constants.ts b/src/cli/cli.constants.ts
new file mode 100644
index 0000000..7629ceb
--- /dev/null
+++ b/src/cli/cli.constants.ts
@@ -0,0 +1,3 @@
+export const FRAGMENT_PREFIX = 'Fragment: ';
+
+export const ENV_PREFIX = 'Env: ';
diff --git a/src/cli/commands/base.command.ts b/src/cli/commands/base.command.ts
index d7583fd..cf41e3b 100644
--- a/src/cli/commands/base.command.ts
+++ b/src/cli/commands/base.command.ts
@@ -7,7 +7,8 @@ import { Command } from 'commander';
import fs from 'fs-extra';
import { ApiResult } from '../../shared/types';
-import { cliConfig } from '../config/cli.config';
+import { cliConfig } from '../cli.config';
+import { ENV_PREFIX, FRAGMENT_PREFIX } from '../cli.constants';
import { handleApiResult } from '../utils/database.util';
import { handleError } from '../utils/error.util';
@@ -75,10 +76,13 @@ export class BaseCommand extends Command {
const tempFilePath = path.join(tempDir, 'input.txt');
try {
- await fs.writeFile(tempFilePath, initialValue);
+ const cleanedInitialValue =
+ initialValue.startsWith(FRAGMENT_PREFIX) || initialValue.startsWith(ENV_PREFIX) ? '' : initialValue;
+ await fs.writeFile(tempFilePath, cleanedInitialValue);
const input = await editor({
message: 'Edit your input',
- default: initialValue,
+ default: cleanedInitialValue,
+ waitForUseInput: false,
postfix: '.txt'
});
return input;
diff --git a/src/cli/commands/env.command.ts b/src/cli/commands/env.command.ts
index f793f90..104ec0f 100644
--- a/src/cli/commands/env.command.ts
+++ b/src/cli/commands/env.command.ts
@@ -2,10 +2,11 @@ import chalk from 'chalk';
import { BaseCommand } from './base.command';
import { EnvVar, Fragment } from '../../shared/types';
-import { formatTitleCase, formatSnakeCase } from '../../shared/utils/string_formatter';
+import { formatTitleCase, formatSnakeCase } from '../../shared/utils/string_formatter.util';
+import { FRAGMENT_PREFIX } from '../cli.constants';
import { createEnvVar, readEnvVars, updateEnvVar, deleteEnvVar } from '../utils/env.util';
-import { listFragments, viewFragmentContent } from '../utils/fragment.util';
-import { listPrompts, getPromptFiles } from '../utils/prompt.util';
+import { listFragments, viewFragmentContent } from '../utils/fragment_operations.util';
+import { listPrompts, getPromptFiles } from '../utils/prompt_crud.util';
class EnvCommand extends BaseCommand {
constructor() {
@@ -36,7 +37,10 @@ class EnvCommand extends BaseCommand {
}
}
- private formatVariableChoices(allVariables: Array<{ name: string; role: string }>, envVars: EnvVar[]): Array<{ name: string; value: { name: string; role: string } }> {
+ private formatVariableChoices(
+ allVariables: Array<{ name: string; role: string }>,
+ envVars: EnvVar[]
+ ): Array<{ name: string; value: { name: string; role: string } }> {
const maxNameLength = Math.max(...allVariables.map((v) => formatSnakeCase(v.name).length));
return allVariables.map((variable) => {
const formattedName = formatSnakeCase(variable.name);
@@ -137,7 +141,7 @@ class EnvCommand extends BaseCommand {
return;
}
- const fragmentRef = `Fragment: ${selectedFragment.category}/${selectedFragment.name}`;
+ const fragmentRef = `${FRAGMENT_PREFIX}${selectedFragment.category}/${selectedFragment.name}`;
const envVars = await this.handleApiResult(await readEnvVars(), 'Fetched environment variables');
if (!envVars) return;
diff --git a/src/cli/commands/execute.command.ts b/src/cli/commands/execute.command.ts
index 5890a08..9b9e43a 100644
--- a/src/cli/commands/execute.command.ts
+++ b/src/cli/commands/execute.command.ts
@@ -4,8 +4,9 @@ import yaml from 'js-yaml';
import { BaseCommand } from './base.command';
import { Metadata, Prompt, Variable } from '../../shared/types';
-import { processPromptContent } from '../../shared/utils/prompt_operations';
-import { getPromptFiles, viewPromptDetails } from '../utils/prompt.util';
+import { processPromptContent } from '../../shared/utils/prompt_processing.util';
+import { getPromptFiles } from '../utils/prompt_crud.util';
+import { viewPromptDetails } from '../utils/prompt_display.util';
class ExecuteCommand extends BaseCommand {
constructor() {
diff --git a/src/cli/commands/fragments.command.ts b/src/cli/commands/fragments.command.ts
index 9eb66e7..a47869c 100644
--- a/src/cli/commands/fragments.command.ts
+++ b/src/cli/commands/fragments.command.ts
@@ -2,8 +2,8 @@ import chalk from 'chalk';
import { BaseCommand } from './base.command';
import { Fragment } from '../../shared/types';
-import { formatTitleCase } from '../../shared/utils/string_formatter';
-import { listFragments, viewFragmentContent } from '../utils/fragment.util';
+import { formatTitleCase } from '../../shared/utils/string_formatter.util';
+import { listFragments, viewFragmentContent } from '../utils/fragment_operations.util';
type FragmentMenuAction = 'all' | 'category' | 'back';
diff --git a/src/cli/commands/menu.command.ts b/src/cli/commands/menu.command.ts
index cce4b40..b938d1d 100644
--- a/src/cli/commands/menu.command.ts
+++ b/src/cli/commands/menu.command.ts
@@ -3,8 +3,8 @@ import { Command } from 'commander';
import { BaseCommand } from './base.command';
import { getConfig } from '../../shared/config';
-import { hasFragments, hasPrompts } from '../utils/content.util';
import { handleError } from '../utils/error.util';
+import { hasFragments, hasPrompts } from '../utils/file_system.util';
type MenuAction = 'sync' | 'prompts' | 'fragments' | 'settings' | 'env' | 'back';
diff --git a/src/cli/commands/prompts.command.ts b/src/cli/commands/prompts.command.ts
index d0b54b2..83119c5 100644
--- a/src/cli/commands/prompts.command.ts
+++ b/src/cli/commands/prompts.command.ts
@@ -2,12 +2,13 @@ import chalk from 'chalk';
import { BaseCommand } from './base.command';
import { CategoryItem, EnvVar, Fragment, Prompt, Variable } from '../../shared/types';
-import { formatTitleCase, formatSnakeCase } from '../../shared/utils/string_formatter';
-import { ConversationManager } from '../utils/conversation.util';
+import { formatTitleCase, formatSnakeCase } from '../../shared/utils/string_formatter.util';
+import { ENV_PREFIX, FRAGMENT_PREFIX } from '../cli.constants';
+import { ConversationManager } from '../utils/conversation_manager.util';
import { fetchCategories, getPromptDetails, updatePromptVariable } from '../utils/database.util';
import { readEnvVars } from '../utils/env.util';
-import { listFragments, viewFragmentContent } from '../utils/fragment.util';
-import { viewPromptDetails } from '../utils/prompt.util';
+import { listFragments, viewFragmentContent } from '../utils/fragment_operations.util';
+import { viewPromptDetails } from '../utils/prompt_display.util';
type PromptMenuAction = 'all' | 'category' | 'id' | 'back';
type SelectPromptMenuAction = Variable | 'execute' | 'unset_all' | 'back';
@@ -216,9 +217,9 @@ class PromptCommand extends BaseCommand {
private getVariableNameColor(v: Variable): (text: string) => string {
if (v.value) {
- if (v.value.startsWith('Fragment: ')) return chalk.blue;
+ if (v.value.startsWith(FRAGMENT_PREFIX)) return chalk.blue;
- if (v.value.startsWith('Env: ')) return chalk.magenta;
+ if (v.value.startsWith(ENV_PREFIX)) return chalk.magenta;
return chalk.green;
}
return v.optional_for_user ? chalk.yellow : chalk.red;
@@ -297,7 +298,7 @@ class PromptCommand extends BaseCommand {
if (!fragmentsResult) return;
const selectedFragment = await this.showMenu<Fragment | 'back'>(
- 'Select a Fragment: ',
+ 'Select a fragment: ',
fragmentsResult.map((f) => ({
name: `${f.category}/${f.name}`,
value: f
@@ -309,7 +310,7 @@ class PromptCommand extends BaseCommand {
return;
}
- const fragmentRef = `Fragment: ${selectedFragment.category}/${selectedFragment.name}`;
+ const fragmentRef = `${FRAGMENT_PREFIX}${selectedFragment.category}/${selectedFragment.name}`;
const updateResult = await updatePromptVariable(promptId, variable.name, fragmentRef);
if (!updateResult.success) {
@@ -361,7 +362,7 @@ class PromptCommand extends BaseCommand {
return;
}
- const envVarRef = `Env: ${selectedEnvVar.name}`;
+ const envVarRef = `${ENV_PREFIX}${selectedEnvVar.name}`;
const updateResult = await updatePromptVariable(promptId, variable.name, envVarRef);
if (!updateResult.success) {
diff --git a/src/cli/commands/sync.command.ts b/src/cli/commands/sync.command.ts
index 159b054..49b55b1 100644
--- a/src/cli/commands/sync.command.ts
+++ b/src/cli/commands/sync.command.ts
@@ -6,8 +6,8 @@ import simpleGit, { SimpleGit } from 'simple-git';
import { BaseCommand } from './base.command';
import { getConfig, setConfig } from '../../shared/config';
-import logger from '../../shared/utils/logger';
-import { cliConfig } from '../config/cli.config';
+import logger from '../../shared/utils/logger.util';
+import { cliConfig } from '../cli.config';
import { syncPromptsWithDatabase, cleanupOrphanedData } from '../utils/database.util';
class SyncCommand extends BaseCommand {
diff --git a/src/cli/utils/conversation.util.ts b/src/cli/utils/conversation_manager.util.ts
similarity index 83%
rename from src/cli/utils/conversation.util.ts
rename to src/cli/utils/conversation_manager.util.ts
index 87aea72..1c5124c 100644
--- a/src/cli/utils/conversation.util.ts
+++ b/src/cli/utils/conversation_manager.util.ts
@@ -1,11 +1,12 @@
import { handleError } from './error.util';
-import { processCliPromptContent, resolveCliInputs } from './prompt.cli.util';
-import { getPromptFiles } from './prompt.util';
+import { resolveCliInputs } from './input_processing.util';
+import { processCliPromptContent } from './input_resolution.util';
+import { getPromptFiles } from './prompt_crud.util';
import { ApiResult } from '../../shared/types';
-import { processPromptContent, processPromptWithVariables } from '../../shared/utils/prompt_operations';
+import { processPromptContent, processPromptWithVariables } from '../../shared/utils/prompt_processing.util';
interface ConversationMessage {
- role: 'human' | 'assistant';
+ role: 'user' | 'assistant';
content: string;
}
@@ -32,7 +33,7 @@ export class ConversationManager {
const { promptContent } = promptFilesResult.data;
const resolvedInputs = isExecuteCommand ? userInputs : await resolveCliInputs(userInputs);
const updatedPromptContent = await processPromptWithVariables(promptContent, resolvedInputs);
- this.messages.push({ role: 'human', content: updatedPromptContent });
+ this.messages.push({ role: 'user', content: updatedPromptContent });
const result = await (isExecuteCommand
? processPromptContent(this.messages, {}, false)
@@ -52,14 +53,14 @@ export class ConversationManager {
async continueConversation(userInput: string, useStreaming: boolean = true): Promise<ApiResult<string>> {
try {
- this.messages.push({ role: 'human', content: userInput });
+ this.messages.push({ role: 'user', content: userInput });
const result = useStreaming
? await processCliPromptContent(this.messages, {}, true)
: await processPromptContent(this.messages, {}, false);
if (typeof result === 'string') {
- this.messages.push({ role: 'assistant', content: result });
+ this.messages.push({ role: 'user', content: result });
return { success: true, data: result };
} else {
return { success: false, error: 'Unexpected result format' };
diff --git a/src/cli/utils/database.util.ts b/src/cli/utils/database.util.ts
index 3a2e345..45e2fbf 100644
--- a/src/cli/utils/database.util.ts
+++ b/src/cli/utils/database.util.ts
@@ -6,12 +6,12 @@ import NodeCache from 'node-cache';
import sqlite3, { RunResult } from 'sqlite3';
import { AppError, handleError } from './error.util';
-import { createPrompt } from './prompt.util';
+import { createPrompt } from './prompt_crud.util';
import { commonConfig } from '../../shared/config/common.config';
import { ApiResult, CategoryItem, Metadata, Prompt, Variable } from '../../shared/types';
-import { fileExists, readDirectory, readFileContent } from '../../shared/utils/file_operations';
-import logger from '../../shared/utils/logger';
-import { cliConfig } from '../config/cli.config';
+import { fileExists, readDirectory, readFileContent } from '../../shared/utils/file_system.util';
+import logger from '../../shared/utils/logger.util';
+import { cliConfig } from '../cli.config';
const db = new sqlite3.Database(cliConfig.DB_PATH);
const cache = new NodeCache({ stdTTL: 600 });
diff --git a/src/cli/utils/error.util.ts b/src/cli/utils/error.util.ts
index f535ad3..c3240d4 100644
--- a/src/cli/utils/error.util.ts
+++ b/src/cli/utils/error.util.ts
@@ -1,6 +1,6 @@
import chalk from 'chalk';
-import logger from '../../shared/utils/logger';
+import logger from '../../shared/utils/logger.util';
export class AppError extends Error {
constructor(
diff --git a/src/cli/utils/content.util.ts b/src/cli/utils/file_system.util.ts
similarity index 86%
rename from src/cli/utils/content.util.ts
rename to src/cli/utils/file_system.util.ts
index 84bed01..0513eda 100644
--- a/src/cli/utils/content.util.ts
+++ b/src/cli/utils/file_system.util.ts
@@ -1,8 +1,8 @@
import fs from 'fs-extra';
import { handleError } from './error.util';
-import { readDirectory } from '../../shared/utils/file_operations';
-import { cliConfig } from '../config/cli.config';
+import { readDirectory } from '../../shared/utils/file_system.util';
+import { cliConfig } from '../cli.config';
export async function hasPrompts(): Promise<boolean> {
try {
diff --git a/src/cli/utils/fragment.util.ts b/src/cli/utils/fragment_operations.util.ts
similarity index 95%
rename from src/cli/utils/fragment.util.ts
rename to src/cli/utils/fragment_operations.util.ts
index bf3a262..5b6bdc2 100644
--- a/src/cli/utils/fragment.util.ts
+++ b/src/cli/utils/fragment_operations.util.ts
@@ -2,8 +2,8 @@ import path from 'path';
import { handleError } from './error.util';
import { ApiResult, Fragment } from '../../shared/types';
-import { readDirectory, readFileContent } from '../../shared/utils/file_operations';
-import { cliConfig } from '../config/cli.config';
+import { readDirectory, readFileContent } from '../../shared/utils/file_system.util';
+import { cliConfig } from '../cli.config';
export async function listFragments(): Promise<ApiResult<Fragment[]>> {
try {
diff --git a/src/cli/utils/prompt.cli.util.ts b/src/cli/utils/input_processing.util.ts
similarity index 53%
rename from src/cli/utils/prompt.cli.util.ts
rename to src/cli/utils/input_processing.util.ts
index 29e63ab..1b877b5 100644
--- a/src/cli/utils/prompt.cli.util.ts
+++ b/src/cli/utils/input_processing.util.ts
@@ -1,13 +1,13 @@
+import { EnvVar } from '../../shared/types';
+import logger from '../../shared/utils/logger.util';
+import { FRAGMENT_PREFIX, ENV_PREFIX } from '../cli.constants';
import { readEnvVars } from './env.util';
import { handleError } from './error.util';
-import { viewFragmentContent } from './fragment.util';
-import { EnvVar } from '../../shared/types';
-import logger from '../../shared/utils/logger';
-import { processPromptContent } from '../../shared/utils/prompt_operations';
+import { viewFragmentContent } from './fragment_operations.util';
export async function resolveValue(value: string, envVars: EnvVar[]): Promise<string> {
- if (value.startsWith('Fragment: ')) {
- const [category, name] = value.split('Fragment: ')[1].split('/');
+ if (value.startsWith(FRAGMENT_PREFIX)) {
+ const [category, name] = value.split(FRAGMENT_PREFIX)[1].split('/');
const fragmentResult = await viewFragmentContent(category, name);
if (fragmentResult.success && fragmentResult.data) {
@@ -16,12 +16,12 @@ export async function resolveValue(value: string, envVars: EnvVar[]): Promise<st
logger.warn(`Failed to load fragment: ${category}/${name}`);
return value;
}
- } else if (value.startsWith('Env: ')) {
- const envVarName = value.split('Env: ')[1];
+ } else if (value.startsWith(ENV_PREFIX)) {
+ const envVarName = value.split(ENV_PREFIX)[1];
const actualEnvVar = envVars.find((v) => v.name === envVarName);
if (actualEnvVar) {
- return await resolveValue(actualEnvVar.value, envVars); // Recursive call to handle nested Env: references
+ return await resolveValue(actualEnvVar.value, envVars); // Recursive call to handle nested env references
} else {
logger.warn(`Env var not found: ${envVarName}`);
return value;
@@ -37,7 +37,7 @@ export async function resolveCliInputs(inputs: Record<string, string>): Promise<
const resolvedInputs: Record<string, string> = {};
for (const [key, value] of Object.entries(inputs)) {
- if (value.startsWith('Fragment: ') || value.startsWith('Env: ')) {
+ if (value.startsWith(FRAGMENT_PREFIX) || value.startsWith(ENV_PREFIX)) {
resolvedInputs[key] = await resolveValue(value, envVars);
} else {
resolvedInputs[key] = value;
@@ -49,24 +49,3 @@ export async function resolveCliInputs(inputs: Record<string, string>): Promise<
throw error;
}
}
-
-export async function processCliPromptContent(
- messages: { role: string; content: string }[],
- inputs: Record<string, string> = {},
- useStreaming: boolean = true
-): Promise<string> {
- try {
- return processPromptContent(messages, inputs, useStreaming, resolveCliInputs, (event) => {
- if (event.type === 'content_block_delta' && event.delta) {
- if ('text' in event.delta) {
- process.stdout.write(event.delta.text);
- } else if ('partial_json' in event.delta) {
- process.stdout.write(event.delta.partial_json);
- }
- }
- });
- } catch (error) {
- handleError(error, 'processing CLI prompt content');
- throw error;
- }
-}
diff --git a/src/cli/utils/input_resolution.util.ts b/src/cli/utils/input_resolution.util.ts
new file mode 100644
index 0000000..bee7b3c
--- /dev/null
+++ b/src/cli/utils/input_resolution.util.ts
@@ -0,0 +1,24 @@
+import { handleError } from './error.util';
+import { resolveCliInputs } from './input_processing.util';
+import { processPromptContent } from '../../shared/utils/prompt_processing.util';
+
+export async function processCliPromptContent(
+ messages: { role: string; content: string }[],
+ inputs: Record<string, string> = {},
+ useStreaming: boolean = true
+): Promise<string> {
+ try {
+ return processPromptContent(messages, inputs, useStreaming, resolveCliInputs, (event) => {
+ if (event.type === 'content_block_delta' && event.delta) {
+ if ('text' in event.delta) {
+ process.stdout.write(event.delta.text);
+ } else if ('partial_json' in event.delta) {
+ process.stdout.write(event.delta.partial_json);
+ }
+ }
+ });
+ } catch (error) {
+ handleError(error, 'processing CLI prompt content');
+ throw error;
+ }
+}
diff --git a/src/cli/utils/prompt.util.ts b/src/cli/utils/prompt.util.ts
deleted file mode 100644
index aad784e..0000000
--- a/src/cli/utils/prompt.util.ts
+++ /dev/null
@@ -1,188 +0,0 @@
-import chalk from 'chalk';
-
-import { allAsync, getAsync, runAsync } from './database.util';
-import { readEnvVars } from './env.util';
-import { handleError } from './error.util';
-import { getPromptMetadata } from './metadata.util';
-import { ApiResult, Metadata, Prompt, Variable } from '../../shared/types';
-import { processPromptContent } from '../../shared/utils/prompt_operations';
-import { formatSnakeCase, formatTitleCase } from '../../shared/utils/string_formatter';
-
-export async function createPrompt(metadata: Metadata, content: string): Promise<ApiResult<void>> {
- try {
- const result = await runAsync(
- 'INSERT INTO prompts (title, content, primary_category, directory, one_line_description, description, content_hash, tags) VALUES (?, ?, ?, ?, ?, ?, ?, ?)',
- [
- metadata.title,
- content,
- metadata.primary_category,
- metadata.directory,
- metadata.one_line_description,
- metadata.description,
- metadata.content_hash,
- metadata.tags.join(',')
- ]
- );
- const promptId = result.data?.lastID;
-
- if (!promptId) {
- return { success: false, error: 'Failed to insert prompt' };
- }
-
- for (const subcategory of metadata.subcategories) {
- await runAsync('INSERT INTO subcategories (prompt_id, name) VALUES (?, ?)', [promptId, subcategory]);
- }
-
- for (const variable of metadata.variables) {
- await runAsync('INSERT INTO variables (prompt_id, name, role, optional_for_user) VALUES (?, ?, ?, ?)', [
- promptId,
- variable.name,
- variable.role,
- variable.optional_for_user
- ]);
- }
-
- for (const fragment of metadata.fragments || []) {
- await runAsync('INSERT INTO fragments (prompt_id, category, name, variable) VALUES (?, ?, ?, ?)', [
- promptId,
- fragment.category,
- fragment.name,
- fragment.variable
- ]);
- }
- return { success: true };
- } catch (error) {
- handleError(error, 'creating prompt');
- return { success: false, error: 'Failed to create prompt' };
- }
-}
-
-export async function executePrompt(
- promptId: string,
- userInputs: Record<string, string>,
- useStreaming: boolean
-): Promise<ApiResult<string>> {
- try {
- const promptFilesResult = await getPromptFiles(promptId);
-
- if (!promptFilesResult.success || !promptFilesResult.data) {
- return { success: false, error: promptFilesResult.error || 'Failed to get prompt files' };
- }
-
- const { promptContent } = promptFilesResult.data;
- const result = await processPromptContent([{ role: 'user', content: promptContent }], userInputs, useStreaming);
- return { success: true, data: result };
- } catch (error) {
- handleError(error, 'executing prompt');
- return { success: false, error: 'Failed to execute prompt' };
- }
-}
-
-export async function listPrompts(): Promise<ApiResult<Prompt[]>> {
- try {
- const prompts = await allAsync<Prompt>('SELECT id, title, primary_category FROM prompts');
- return { success: true, data: prompts.data ?? [] };
- } catch (error) {
- handleError(error, 'listing prompts');
- return { success: false, error: 'Failed to list prompts' };
- }
-}
-
-export async function getPromptFiles(
- promptId: string
-): Promise<ApiResult<{ promptContent: string; metadata: Metadata }>> {
- try {
- const promptContentResult = await getAsync<{ content: string }>('SELECT content FROM prompts WHERE id = ?', [
- promptId
- ]);
-
- if (!promptContentResult.success || !promptContentResult.data) {
- return { success: false, error: 'Prompt not found' };
- }
-
- const metadataResult = await getPromptMetadata(promptId);
-
- if (!metadataResult.success || !metadataResult.data) {
- return { success: false, error: 'Failed to get prompt metadata' };
- }
- return {
- success: true,
- data: {
- promptContent: promptContentResult.data.content,
- metadata: metadataResult.data
- }
- };
- } catch (error) {
- handleError(error, 'getting prompt files');
- return { success: false, error: 'Failed to get prompt files' };
- }
-}
-
-export async function viewPromptDetails(details: Prompt & { variables: Variable[] }, isExecute = false): Promise<void> {
- // console.clear();
- console.log(chalk.cyan('Prompt:'), details.title);
- console.log(`\n${details.description || ''}`);
- console.log(chalk.cyan('\nCategory:'), formatTitleCase(details.primary_category));
-
- let tags: string[] = [];
-
- if (typeof details.tags === 'string') {
- tags = details.tags.split(',').map((tag) => tag.trim());
- } else if (Array.isArray(details.tags)) {
- tags = details.tags;
- }
-
- console.log(chalk.cyan('\nTags:'), tags.length > 0 ? tags.join(', ') : 'No tags');
- console.log(chalk.cyan('\nOptions:'), '([*] Required [ ] Optional)');
- const maxNameLength = Math.max(...details.variables.map((v) => formatSnakeCase(v.name).length));
-
- try {
- const envVarsResult = await readEnvVars();
- const envVars = envVarsResult.success ? envVarsResult.data || [] : [];
-
- for (const variable of details.variables) {
- const paddedName = formatSnakeCase(variable.name).padEnd(maxNameLength);
- const requiredFlag = variable.optional_for_user ? '[ ]' : '[*]';
- const matchingEnvVar = envVars.find((v) => v.name === variable.name);
- let status;
-
- if (variable.value) {
- if (variable.value.startsWith('Fragment: ')) {
- status = chalk.blue(variable.value);
- } else if (variable.value.startsWith('Env: ')) {
- const envVarName = variable.value.split('Env: ')[1];
- const envVar = envVars.find((v: { name: string }) => v.name === envVarName);
- const envValue = envVar ? envVar.value : 'Not found';
- status = chalk.magenta(
- `Env: ${formatSnakeCase(envVarName)} (${envValue.substring(0, 30)}${envValue.length > 30 ? '...' : ''})`
- );
- } else {
- status = chalk.green(
- `Set: ${variable.value.substring(0, 30)}${variable.value.length > 30 ? '...' : ''}`
- );
- }
- } else {
- status = variable.optional_for_user ? chalk.yellow('Not Set') : chalk.red('Not Set (Required)');
- }
-
- const hint =
- !isExecute &&
- matchingEnvVar &&
- (!variable.value || (variable.value && !variable.value.startsWith('Env: ')))
- ? chalk.magenta('(Env variable available)')
- : '';
- console.log(` ${chalk.green(`--${paddedName}`)} ${requiredFlag} ${hint}`);
- console.log(` ${variable.role}`);
-
- if (!isExecute) {
- console.log(` ${status}`);
- }
- }
-
- if (!isExecute) {
- console.log();
- }
- } catch (error) {
- handleError(error, 'viewing prompt details');
- }
-}
diff --git a/src/cli/utils/prompt_crud.util.ts b/src/cli/utils/prompt_crud.util.ts
new file mode 100644
index 0000000..7450745
--- /dev/null
+++ b/src/cli/utils/prompt_crud.util.ts
@@ -0,0 +1,93 @@
+import { allAsync, getAsync, runAsync } from './database.util';
+import { handleError } from './error.util';
+import { getPromptMetadata } from './metadata.util';
+import { ApiResult, Metadata, Prompt } from '../../shared/types';
+
+export async function createPrompt(metadata: Metadata, content: string): Promise<ApiResult<void>> {
+ try {
+ const result = await runAsync(
+ 'INSERT INTO prompts (title, content, primary_category, directory, one_line_description, description, content_hash, tags) VALUES (?, ?, ?, ?, ?, ?, ?, ?)',
+ [
+ metadata.title,
+ content,
+ metadata.primary_category,
+ metadata.directory,
+ metadata.one_line_description,
+ metadata.description,
+ metadata.content_hash,
+ metadata.tags.join(',')
+ ]
+ );
+ const promptId = result.data?.lastID;
+
+ if (!promptId) {
+ return { success: false, error: 'Failed to insert prompt' };
+ }
+
+ for (const subcategory of metadata.subcategories) {
+ await runAsync('INSERT INTO subcategories (prompt_id, name) VALUES (?, ?)', [promptId, subcategory]);
+ }
+
+ for (const variable of metadata.variables) {
+ await runAsync('INSERT INTO variables (prompt_id, name, role, optional_for_user) VALUES (?, ?, ?, ?)', [
+ promptId,
+ variable.name,
+ variable.role,
+ variable.optional_for_user
+ ]);
+ }
+
+ for (const fragment of metadata.fragments || []) {
+ await runAsync('INSERT INTO fragments (prompt_id, category, name, variable) VALUES (?, ?, ?, ?)', [
+ promptId,
+ fragment.category,
+ fragment.name,
+ fragment.variable
+ ]);
+ }
+ return { success: true };
+ } catch (error) {
+ handleError(error, 'creating prompt');
+ return { success: false, error: 'Failed to create prompt' };
+ }
+}
+
+export async function listPrompts(): Promise<ApiResult<Prompt[]>> {
+ try {
+ const prompts = await allAsync<Prompt>('SELECT id, title, primary_category FROM prompts');
+ return { success: true, data: prompts.data ?? [] };
+ } catch (error) {
+ handleError(error, 'listing prompts');
+ return { success: false, error: 'Failed to list prompts' };
+ }
+}
+
+export async function getPromptFiles(
+ promptId: string
+): Promise<ApiResult<{ promptContent: string; metadata: Metadata }>> {
+ try {
+ const promptContentResult = await getAsync<{ content: string }>('SELECT content FROM prompts WHERE id = ?', [
+ promptId
+ ]);
+
+ if (!promptContentResult.success || !promptContentResult.data) {
+ return { success: false, error: 'Prompt not found' };
+ }
+
+ const metadataResult = await getPromptMetadata(promptId);
+
+ if (!metadataResult.success || !metadataResult.data) {
+ return { success: false, error: 'Failed to get prompt metadata' };
+ }
+ return {
+ success: true,
+ data: {
+ promptContent: promptContentResult.data.content,
+ metadata: metadataResult.data
+ }
+ };
+ } catch (error) {
+ handleError(error, 'getting prompt files');
+ return { success: false, error: 'Failed to get prompt files' };
+ }
+}
diff --git a/src/cli/utils/prompt_display.util.ts b/src/cli/utils/prompt_display.util.ts
new file mode 100644
index 0000000..b2a8f77
--- /dev/null
+++ b/src/cli/utils/prompt_display.util.ts
@@ -0,0 +1,76 @@
+import chalk from 'chalk';
+
+import { Prompt, Variable } from '../../shared/types';
+import { formatTitleCase, formatSnakeCase } from '../../shared/utils/string_formatter.util';
+import { FRAGMENT_PREFIX, ENV_PREFIX } from '../cli.constants';
+import { readEnvVars } from './env.util';
+import { handleError } from './error.util';
+
+export async function viewPromptDetails(details: Prompt & { variables: Variable[] }, isExecute = false): Promise<void> {
+ // console.clear();
+ console.log(chalk.cyan('Prompt:'), details.title);
+ console.log(`\n${details.description || ''}`);
+ console.log(chalk.cyan('\nCategory:'), formatTitleCase(details.primary_category));
+
+ let tags: string[] = [];
+
+ if (typeof details.tags === 'string') {
+ tags = details.tags.split(',').map((tag) => tag.trim());
+ } else if (Array.isArray(details.tags)) {
+ tags = details.tags;
+ }
+
+ console.log(chalk.cyan('\nTags:'), tags.length > 0 ? tags.join(', ') : 'No tags');
+ console.log(chalk.cyan('\nOptions:'), '([*] Required [ ] Optional)');
+ const maxNameLength = Math.max(...details.variables.map((v) => formatSnakeCase(v.name).length));
+
+ try {
+ const envVarsResult = await readEnvVars();
+ const envVars = envVarsResult.success ? envVarsResult.data || [] : [];
+
+ for (const variable of details.variables) {
+ const paddedName = formatSnakeCase(variable.name).padEnd(maxNameLength);
+ const requiredFlag = variable.optional_for_user ? '[ ]' : '[*]';
+ const matchingEnvVar = envVars.find((v) => v.name === variable.name);
+ let status;
+
+ if (variable.value) {
+ if (variable.value.startsWith(FRAGMENT_PREFIX)) {
+ status = chalk.blue(variable.value);
+ } else if (variable.value.startsWith(ENV_PREFIX)) {
+ const envVarName = variable.value.split(ENV_PREFIX)[1];
+ const envVar = envVars.find((v: { name: string }) => v.name === envVarName);
+ const envValue = envVar ? envVar.value : 'Not found';
+ status = chalk.magenta(
+ `${ENV_PREFIX}${formatSnakeCase(envVarName)} (${envValue.substring(0, 30)}${envValue.length > 30 ? '...' : ''})`
+ );
+ } else {
+ status = chalk.green(
+ `Set: ${variable.value.substring(0, 30)}${variable.value.length > 30 ? '...' : ''}`
+ );
+ }
+ } else {
+ status = variable.optional_for_user ? chalk.yellow('Not Set') : chalk.red('Not Set (Required)');
+ }
+
+ const hint =
+ !isExecute &&
+ matchingEnvVar &&
+ (!variable.value || (variable.value && !variable.value.startsWith(ENV_PREFIX)))
+ ? chalk.magenta('(Env variable available)')
+ : '';
+ console.log(` ${chalk.green(`--${paddedName}`)} ${requiredFlag} ${hint}`);
+ console.log(` ${variable.role}`);
+
+ if (!isExecute) {
+ console.log(` ${status}`);
+ }
+ }
+
+ if (!isExecute) {
+ console.log();
+ }
+ } catch (error) {
+ handleError(error, 'viewing prompt details');
+ }
+}
diff --git a/src/shared/config/index.ts b/src/shared/config/index.ts
index cf2518d..516bcd1 100644
--- a/src/shared/config/index.ts
+++ b/src/shared/config/index.ts
@@ -3,7 +3,7 @@ import * as fs from 'fs';
import { CommonConfig, commonConfig } from './common.config';
import { CONFIG_DIR, CONFIG_FILE, isCliEnvironment } from './config.constants';
import { AppConfig, appConfig } from '../../app/config/app.config';
-import { CliConfig, cliConfig } from '../../cli/config/cli.config';
+import { CliConfig, cliConfig } from '../../cli/cli.config';
export type Config = CommonConfig & (CliConfig | AppConfig);
diff --git a/src/shared/utils/anthropic_client.ts b/src/shared/utils/anthropic_client.util.ts
similarity index 94%
rename from src/shared/utils/anthropic_client.ts
rename to src/shared/utils/anthropic_client.util.ts
index e7d22c8..cec4634 100644
--- a/src/shared/utils/anthropic_client.ts
+++ b/src/shared/utils/anthropic_client.util.ts
@@ -22,13 +22,12 @@ function getAnthropicClient(): Anthropic {
export async function sendAnthropicRequestClassic(messages: { role: string; content: string }[]): Promise<Message> {
const client = getAnthropicClient();
-
try {
return await client.messages.create({
model: commonConfig.ANTHROPIC_MODEL,
max_tokens: commonConfig.ANTHROPIC_MAX_TOKENS,
messages: messages.map((msg) => ({
- role: msg.role === 'human' ? 'user' : 'assistant',
+ role: msg.role === 'user' ? 'user' : 'assistant',
content: msg.content
}))
});
@@ -48,7 +47,7 @@ export async function* sendAnthropicRequestStream(
model: commonConfig.ANTHROPIC_MODEL,
max_tokens: commonConfig.ANTHROPIC_MAX_TOKENS,
messages: messages.map((msg) => ({
- role: msg.role === 'human' ? 'user' : 'assistant',
+ role: msg.role === 'user' ? 'user' : 'assistant',
content: msg.content
}))
});
diff --git a/src/shared/utils/file_operations.ts b/src/shared/utils/file_system.util.ts
similarity index 100%
rename from src/shared/utils/file_operations.ts
rename to src/shared/utils/file_system.util.ts
diff --git a/src/shared/utils/logger.ts b/src/shared/utils/logger.util.ts
similarity index 100%
rename from src/shared/utils/logger.ts
rename to src/shared/utils/logger.util.ts
diff --git a/src/shared/utils/prompt_operations.ts b/src/shared/utils/prompt_processing.util.ts
similarity index 99%
rename from src/shared/utils/prompt_operations.ts
rename to src/shared/utils/prompt_processing.util.ts
index 6078626..ae4defa 100644
--- a/src/shared/utils/prompt_operations.ts
+++ b/src/shared/utils/prompt_processing.util.ts
@@ -1,6 +1,6 @@
import { Message } from '@anthropic-ai/sdk/resources';
-import { sendAnthropicRequestClassic, sendAnthropicRequestStream } from './anthropic_client';
+import { sendAnthropicRequestClassic, sendAnthropicRequestStream } from './anthropic_client.util';
import { handleError } from '../../cli/utils/error.util';
export function replaceVariables(content: string, variables: Record<string, string>): string {
diff --git a/src/shared/utils/string_formatter.ts b/src/shared/utils/string_formatter.util.ts
similarity index 100%
rename from src/shared/utils/string_formatter.ts
rename to src/shared/utils/string_formatter.util.ts