🚀 Instruere - AI Prompt Manager

The intelligent way to manage, optimize, and scale your AI prompts

A comprehensive AI prompt management system featuring a modern web interface (FastAPI + HTMX + Tailwind CSS) with unified architecture supporting both single-user and multi-tenant deployments. Features advanced authentication, real-time cost estimation, AI-powered optimization, and secure API access.

graph LR
    A[🤖 AI Prompts] --> B[📝 Management] --> C[🚀 Optimization] --> D[💰 Cost Control]
    
    style A fill:#e3f2fd,stroke:#1976d2,stroke-width:2px,color:#000
    style B fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px,color:#000
    style C fill:#e8f5e8,stroke:#388e3c,stroke-width:2px,color:#000
    style D fill:#fff3e0,stroke:#f57c00,stroke-width:2px,color:#000

🎯 What is Instruere?

Instruere transforms how you work with AI by providing a centralized platform to manage, optimize, and scale your AI prompts and rules. Whether you're a developer, content creator, or enterprise team, Instruere helps you get consistent, high-quality results from AI systems.

The Challenge vs Solution

graph LR
    subgraph P ["❌ Problems"]
        P1[Scattered prompts]
        P2[No cost visibility]
        P3[Manual optimization]
    end
    
    subgraph S ["✅ Solutions"]
        S1[Centralized library]
        S2[Real-time costs]
        S3[AI optimization]
    end
    
    P --> S
    
    style P fill:#ffebee,stroke:#d32f2f,stroke-width:2px,color:#000
    style S fill:#e8f5e8,stroke:#388e3c,stroke-width:2px,color:#000
    style P1 fill:#fff,stroke:#d32f2f,color:#000
    style P2 fill:#fff,stroke:#d32f2f,color:#000
    style P3 fill:#fff,stroke:#d32f2f,color:#000
    style S1 fill:#fff,stroke:#388e3c,color:#000
    style S2 fill:#fff,stroke:#388e3c,color:#000
    style S3 fill:#fff,stroke:#388e3c,color:#000

🌟 Key Features

• 📚 Smart Prompt Management: Organize, search, and reuse your best prompts
• 💰 Real-time Cost Control: See token costs before you spend
• 🚀 AI-Powered Optimization: Improve prompts with LangWatch, PromptPerfect, and more
• 🧩 Visual Builder: Drag-and-drop prompt and rule combination
• 🎤 Speech Dictation: Voice-to-text with AI enhancement
• 🌐 Multi-Language: 10 languages with automatic translation
• 🏢 Enterprise Ready: Multi-tenant with SSO, RBAC, and audit trails
• 🔌 Developer Friendly: Complete REST API with comprehensive documentation

📚 Rules Management: The Foundation of AI Agents

Rules are structured guidelines that define how AI agents should behave and work together. Unlike prompts that request specific outputs, rules establish the framework for consistent, reliable AI operations.

graph TB
    subgraph "AI Agent Ecosystem"
        A[Agent 1: Code Review] --> C[Shared Rules Engine]
        B[Agent 2: Documentation] --> C
        D[Agent 3: Testing] --> C
        E[Agent 4: Deployment] --> C
    end
    
    C --> F[Consistent Quality]
    C --> G[Reliable Outcomes]
    C --> H[Predictable Behavior]
    
    style C fill:#e3f2fd,stroke:#1976d2,stroke-width:3px,color:#000
    style F fill:#e8f5e8,stroke:#388e3c,stroke-width:2px,color:#000
    style G fill:#e8f5e8,stroke:#388e3c,stroke-width:2px,color:#000
    style H fill:#e8f5e8,stroke:#388e3c,stroke-width:2px,color:#000

Real-World Applications:

• Code Quality: Enforcing style guides, security practices, and architecture patterns
• Documentation Standards: Ensuring consistent, comprehensive documentation
• Testing Requirements: Maintaining coverage and quality thresholds
• Collaboration Guidelines: Defining how multiple agents coordinate work

📋 Table of Contents

🚀 Getting Started

• ⚡ Quick Start - Get up and running in 5 minutes
• ⚙️ Configuration - Setup and customization
• ✅ Verify Installation - Test your setup

🎯 Core Features

• 📝 Prompt Management - Create, organize, and manage prompts
• 💰 Token Calculator - Real-time cost estimation
• 🚀 AI-Powered Optimization - Improve prompt quality
• 🧩 Prompt Builder - Drag-and-drop prompt combination
• 🎤 Speech Dictation - Voice-to-text with AI enhancement

🌐 Advanced Features

• 🤖 Enhanced AI Services - Multi-model AI setup
• 🌍 Multi-Language Support - 10 languages with translation
• 📚 Rules Management - AI agent guidance and behavioral rules
• 🏷️ Advanced Tagging System - Intelligent organization

🏢 Enterprise & Deployment

• 🔑 API Access - REST API for developers
• 🏢 Multi-Tenant Features - Organization management
• 🔒 Production Deployment - Scale and security
• 🛠️ Development - Contributing and extending

📚 Resources

• 🏗️ System Architecture - Understanding the design
• 🚀 Quick Reference - Commands and shortcuts
• 🔧 Troubleshooting - Common issues and solutions
• 📄 License - Usage terms

🏗️ System Architecture

Instruere is built on a unified, modular architecture that scales from single-user development to enterprise multi-tenant deployments.

graph TB
    Client[🌐 Client Layer<br/>Modern Web UI • API • Mobile] --> App[🚀 Application Layer<br/>FastAPI + HTMX • Auth • Real-time]
    App --> Logic[🧠 Business Logic<br/>Prompts • Calculator • Optimizer • AI Services]
    Logic --> Data[💾 Data Layer<br/>SQLite • PostgreSQL • Multi-tenant]
    
    style Client fill:#e3f2fd,stroke:#1976d2,stroke-width:2px,color:#000
    style App fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px,color:#000
    style Logic fill:#e8f5e8,stroke:#388e3c,stroke-width:2px,color:#000
    style Data fill:#fff3e0,stroke:#f57c00,stroke-width:2px,color:#000

🆕 Modern Modular Architecture

Instruere features a hybrid architecture that combines proven legacy components with a new modular architecture designed for maintainability, scalability, and enterprise deployment:

• 📦 Modular Design: Clean separation between authentication, prompts, API, and UI layers
• 🏗️ Base Classes: Shared functionality through inheritance and composition patterns
• 🔧 Dependency Injection: Testable, loosely-coupled components with full dependency injection
• 🛡️ Type Safety: Comprehensive type hints throughout the codebase for reliability
• 📋 Structured Logging: Centralized logging with audit trails and performance metrics
• ⚡ Modern Security: Argon2/bcrypt password hashing, JWT management, and RBAC
• 🐳 Container Ready: Full Docker support with Redis caching and health monitoring

📖 Architecture Documentation:

• Development Guide - Complete system architecture with diagrams and implementation details

🔑 Key Architectural Principles

• 🏗️ Unified Codebase: Single application, multiple deployment modes
• 🔐 Tenant Isolation: Complete data separation between organizations
• 📦 Modular Design: Loosely coupled, independently testable components
• 🔌 API-First: RESTful API with comprehensive OpenAPI documentation
• ⚡ Performance: Efficient database queries and caching strategies

📚 Documentation

📖 Comprehensive Guides

• 🚀 Quick Start - Get up and running in 5 minutes
• 👤 User Guide - Complete user documentation for all features
• ⚙️ Configuration - AI services, deployment, and system setup
• 🛠️ Development - Architecture, testing, and development workflows
• 🔌 API Reference - Complete REST API documentation with examples
• ✨ Features Guide - Speech dictation, rules management, and advanced features
• 🚀 Release Management - Versioning, releases, and deployment automation
• 🤖 Deployment Automation - CI/CD pipelines and automation setup

---

⚡ Quick Start

Get Instruere running in under 5 minutes with these simple steps:

✅ Python 3.12+
✅ Poetry (recommended) or pip  
✅ Optional: PostgreSQL for production

🐳 Option 1: Docker (Recommended)

# 🚀 Quick Start - Single Container
docker run -p 7860:7860 ghcr.io/makercorn/ai-prompt-manager:latest

# 🏗️ Development - Full Stack with PostgreSQL & Redis
docker-compose up -d

# 🏭 Production - Optimized with Health Checks
docker-compose -f docker-compose.prod.yml up -d

# 🧪 Test Docker Setup
./scripts/docker-test.sh

# Open browser to http://localhost:7860
# Login: admin@localhost / admin123

🐍 Option 2: Python Installation

📦 From PyPI (Recommended)

# 1️⃣ Install from PyPI
pip install promptman

# 2️⃣ Run the application
python -m promptman

# 3️⃣ Open browser to http://localhost:7860

🏢 From GitHub Packages (Enterprise)

# 1️⃣ Install from GitHub Packages
pip install --index-url https://pypi.pkg.github.com/makercorn/simple/ promptman

# 2️⃣ Run the application
python -m promptman

# 3️⃣ Open browser to http://localhost:7860

🔧 From Source (Development)

# 1️⃣ Clone and install
git clone <repository-url>
cd ai-prompt-manager
poetry install

# 2️⃣ Configure (optional)
cp .env.example .env
# Edit .env for custom settings

# 3️⃣ Launch application (IMPORTANT: Use Poetry environment)
poetry run python run.py

# 4️⃣ Open browser to http://localhost:7860

# ⚠️  CRITICAL: Always use 'poetry run' to ensure dependencies are available
# Running python run.py directly may result in "Create New Prompt