Skip to main content

Egregore home page

GitHub
Get Started
Get Started

Getting Started

Quickstart Guide

Core Concepts

Core Concepts Overview
PACT Architecture
Agents
Context Management
Message Scheduler
Context History
Messaging System
Provider System

Scaffolds

Scaffolds Overview
Creating Scaffolds
Scaffold IPC
Built-in Scaffolds
Retention Management

Hooks

Hooks Overview
Tool Hooks
Context Hooks
Streaming Hooks
Message Hooks
Scaffold Hooks
Subscribe API
Hooks Reference

Workflows

Workflows Overview
Creating Nodes
Sequences
Parallel Execution
Agent Discovery
Validation
Type Checking
Shared State
Workflow Examples

Tools

Tools Overview
Tool Decorator
Tool Execution
Schema System
Modifying Outputs

Other Features

Event Streaming
Telemetry
Component Triggers
Semantic Functions
Multimedia Support

Guides - Getting Started

Installation
Your First Agent
Environment Setup

Guides - Basic Usage

Agent Basics
Context Operations
Streaming
Event Streaming
Error Handling

Guides - Advanced

Custom Scaffolds
Hook Patterns
Workflow Patterns
TTL Management
Context Debugging
Telemetry Integration

Guides - Testing & Debugging

Testing Strategies
Context Explorer
Workflow Debugging
Common Issues

Architecture

Architecture Overview
PACT Specification
Context Internals
TTL Lifecycle
ODI System
Render Lifecycle
Message Scheduler Internals
Tool Task Loop
Streaming Orchestrator
Agent State System
Provider Architecture

Contributing

Getting Started
Development Setup
Testing
Adding Providers
Code Style
Documentation
Release Process

Reference

PACT Selectors
Hook Types
Error Codes
Configuration Options
Glossary

Migration

Migrating from V1
Breaking Changes

API - Agent

Agent API Overview
Constructor
Methods
Properties
Lifecycle

API - Context

Context API Overview
Operations
Access
Serialization
History

API - Scaffolds

Base Scaffold
Scaffold State
Operation Decorator
Change Tracking
Registry
Built-in Scaffolds

API - Tools

Tool Declaration
Tool Executor
Tool Registry
Schema

API - Hooks

Hook Decorators
Execution Contexts
Hook Registration
Subscribe API

API - Providers

Base Provider
Provider Methods
Format Methods
Token Counting
Supported Providers

API - Workflow

Nodes
Sequence
Parallel
Decision
Shared State
Validation
Type Checking
Agent Discovery

API - Messaging

Provider Thread
Message Types
Content Blocks
Usage

API - Accessors

Provider Accessor
Config Accessor
Thread Accessor
History Accessor

API - Analytics

Context Explorer
Telemetry Engine
Workflow Reporting

API - Configuration

Egregore Config
Telemetry Config

Examples - Basic

Hello World
Context Usage
Tool Usage
Streaming
Event Streaming

Examples - Scaffolds

Internal Notes
File Manager
Shell Scaffold
Custom Scaffold

Examples - Workflows

Simple Sequence
Parallel Execution
Decision Logic
Agent Orchestration
Complex Workflow

Examples - Hooks

Tool Hooks
Context Hooks
Message Editing
Subscribe API

Examples - Advanced

TTL Components
Render Lifecycle
Telemetry Integration
Context Debugging
Multi-turn Conversation

Examples - Real-World

Chatbot
Data Pipeline
Research Assistant
Code Reviewer

Installation

Guides - Getting Started

Installation

Documentation coming soon

Installation

[Content coming soon]

Was this page helpful?

Multimedia Support Your First Agent

⌘I

Powered by Mintlify