Pulsar Workflow Engine Documentation

Welcome to Pulsar, a declarative workflow engine for orchestrating AI agents in YAML-defined workflows.

🚀 Quick Start

Get up and running in minutes with our Quick Start Guide guide.

📚 User Guide

Learn how to create workflows, use templates, and leverage advanced features.

🔧 API Reference

Complete API documentation for all modules and classes.

🏗️ Architecture

Understand the system design and internal workings.

🤝 Contributing

Help improve Pulsar by contributing code, documentation, or reporting issues.

Getting Started

• Quick Start Guide
  • Installation
  • Your First Workflow
  • Multi-Agent Workflow
  • Conditional Workflows
  • Using Templates
  • Local AI Models
  • Next Steps
• Installation
  • System Requirements
  • Installation Methods
  • AI Provider Setup
  • Verification
  • Troubleshooting
  • Development Installation
• Configuration
  • Environment Variables
  • Configuration File
  • Workflow-Specific Configuration
  • Command-Line Options
  • Provider-Specific Settings
  • Proxy Configuration
  • Security Considerations
  • Configuration Validation
  • Example Configurations

User Guide

• Workflow Fundamentals
  • Workflow Structure
  • Step Types
  • Templates and Variables
  • Advanced Features
  • Workflow Validation
  • Best Practices
  • Example Workflows

API Reference

• API Reference
• Core Classes
  • Pulsar Engine
• Agent System
  • Base Agent
  • Agent Factory
  • Provider Agents
  • Agent Configuration
• CLI Interface
  • Main CLI
  • CLI Configuration
  • History Management
  • Progress Tracking
  • Plugin System
• Input Providers
  • Base Provider
• Step Handlers
  • Base Handler
• Models
  • StateManager
  • TemplateRenderer
• Exceptions
  • PulsarEngine
  • AgentResult
  • AgentConfig
• Utility Functions
  • Expression Evaluation
  • Configuration Helpers
  • Plugin Loading
• Type Definitions
• Constants
• Environment Variables
  • Core Configuration
  • Provider Configuration
  • Execution Configuration
  • CLI Configuration

Advanced Topics

• Architecture Overview
• System Overview
• Core Principles
  • Modularity
  • Extensibility
  • Type Safety
  • Asynchronous Design
• Component Architecture
  • Workflow Engine
  • Agent System
• Step Execution Flow
  • Step Types
• Data Flow
  • Context Management
  • Template System
  • Expression Evaluation
• Error Handling
  • Exception Hierarchy
  • Retry Logic
  • Circuit Breaker Pattern
• Performance Considerations
  • Concurrency Model
  • Memory Management
  • Optimization Strategies
• Security Architecture
  • API Key Management
  • Input Validation
  • Network Security
  • Plugin Security
• Deployment Patterns
  • Single Node
  • Cloud Deployment
  • Container Deployment
• Monitoring and Observability
  • Logging
  • Metrics
  • Tracing
  • Health Checks
• Future Extensions

Development

• Contributing Guide
• Development Setup
• Project Structure
• Development Workflow
• Code Style
• Testing
• Documentation
• Adding New Features
• Release Process
• Changelog
• Community Guidelines
• Getting Help

Indices and tables

• Index

• Module Index

• Search Page