README.md

Qirrel Documentation

This directory is the source-of-truth for how to use Qirrel in production.

How to Use This Docs Set

1. Start with Basic Usage if you are integrating Qirrel for the first time.
2. Read API Reference for exact signatures and behavior.
3. Read Configuration Guide before shipping to production.
4. Use Architecture Walkthrough to understand internals and extension points.
5. If you are integrating with agents, read Agent-Native Integration.

Core Docs

• Project README
• API Reference
• Configuration Guide
• Usage Examples
• Basic Usage
• Caching
• Pipeline Events
• LLM Integration
• Architecture Walkthrough

Agent and Interop Docs

• Agent-Native Integration
• Agent Feature Roadmap

Benchmark and Positioning Docs

• Benchmarks
• Benchmark Report (Local Machine)
• Framework Comparison
• Ecosystem Comparison

Conventions Used in These Docs

• Examples use TypeScript.
• Install/run commands prefer Bun to match this repository scripts.
• Config keys and runtime behavior are documented against the current src/* implementation.
• When behavior differs by provider (for example LLM adapters), docs call that out explicitly.