> ## Documentation Index
> Fetch the complete documentation index at: https://qitor.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# QitOS Documentation

> The torch-flavor framework for agent researchers building reproducible LLM agents on one AgentModule + Engine kernel.

QitOS is a PyTorch-style framework for agent researchers. It lets you prototype methods, run benchmarks, and inspect long-horizon trajectories on a single `AgentModule + Engine` kernel, with built-in observability via `qita` (the trace viewer that ships with QitOS).

## Two authoring paths

QitOS offers two top-level ways to build agents:

* **Research-first**: handwrite the prompt, parser, protocol (the output format contract between model and parser), transport (the client that talks to the model API), and tool surface so you can study and optimize the kernel directly.
* **Preset-first**: start from family presets (pre-configured model-family defaults) and preset tool builders when you want a fast baseline or quick multi-family switching.

Both paths are first-class citizens in the framework.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Run your first agent in under 2 minutes
  </Card>

  <Card title="Build Your First Agent" icon="code" href="/guides/build-your-first-agent">
    Step-by-step walkthrough to build a working agent
  </Card>

  <Card title="Tutorial Track" icon="graduation-cap" href="/tutorials">
    Learn QitOS through four course-style agent builds
  </Card>

  <Card title="Core Concepts" icon="book" href="/concepts/agent-module">
    Understand AgentModule, Engine, State, and Tools
  </Card>

  <Card title="API Reference" icon="rectangle-terminal" href="/reference/api">
    Full reference for the public QitOS API
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="Research-first path" icon="flask" href="/guides/build-your-first-agent">
    Handwrite prompt, parser, protocol, and tool surface on top of the kernel.
  </Card>

  <Card title="Preset-first path" icon="shuffle" href="/tutorials/switch-model-families">
    Use family presets to switch one example across multiple model families.
  </Card>
</CardGroup>

## Get up and running

<Steps>
  <Step title="Install QitOS">
    ```bash theme={null}
    pip install "qitos[models]"
    ```
  </Step>

  <Step title="Set your provider config">
    ```bash theme={null}
    export OPENAI_API_KEY="sk-..."
    export OPENAI_BASE_URL="https://api.siliconflow.cn/v1/"
    export QITOS_MODEL="Qwen/Qwen3-8B"
    ```
  </Step>

  <Step title="Run the minimal coding agent">
    ```bash theme={null}
    qit demo minimal
    ```
  </Step>

  <Step title="Inspect your run with qita">
    ```bash theme={null}
    qita board --logdir runs
    ```

    Open [http://127.0.0.1:8765](http://127.0.0.1:8765) to view trace, replay, and export your run.
  </Step>
</Steps>

## What QitOS gives you

<CardGroup cols={2}>
  <Card title="Agent Patterns" icon="diagram-project" href="/guides/agent-patterns">
    ReAct, PlanAct, Tree-of-Thought, and Reflexion out of the box
  </Card>

  <Card title="Course-style tutorials" icon="graduation-cap" href="/tutorials">
    ReAct, PlanAct, Claude Code-style, and security audit lessons
  </Card>

  <Card title="Observability" icon="chart-line" href="/guides/observability">
    Built-in tracing with qita board, replay, and HTML export
  </Card>

  <Card title="Benchmarks" icon="trophy" href="/benchmarks/overview">
    GAIA, Tau-Bench, and CyBench adapters on the same kernel
  </Card>

  <Card title="Kit Toolkit" icon="toolbox" href="/reference/kit">
    Parsers, memory adapters, toolsets, critics, and planners
  </Card>
</CardGroup>

## Featured designs

<CardGroup cols={2}>
  <Card title="Single kernel" icon="cpu" href="/concepts/engine">
    One `AgentModule + Engine` runtime across examples, benchmarks, and production-style agents
  </Card>

  <Card title="Protocol-aware parsers" icon="brackets-curly" href="/reference/kit">
    Prompt format and parser choice are paired intentionally, not left as implicit glue code
  </Card>

  <Card title="Long-running context control" icon="clock-rotate-left" href="/guides/memory-and-history">
    History policy, summary history, compact history, and memory adapters for sustained runs
  </Card>

  <Card title="Traceability with qita" icon="chart-line" href="/guides/observability">
    Board, replay, and export built on top of structured trace artifacts
  </Card>
</CardGroup>