> ## 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 文档

> 面向智能体研究者的类 PyTorch 风格框架，用单一 AgentModule + Engine 内核构建可复现的 LLM 智能体。

QitOS 是面向智能体（agent）研究者的类 PyTorch 风格框架。你可以在同一个 `AgentModule + Engine` 内核上原型化方法、运行基准测试（benchmark），并用内建 `qita` 观察长时运行轨迹（trajectory）。

## 两种编写方式

QitOS 提供两种顶层的智能体编写方式：

* 研究优先（research-first）：手写提示词（prompt）、解析器（parser）、协议（protocol，模型输出的格式契约）、传输层（transport，与模型 API 通信的客户端）和工具面（tool surface），直接研究与优化内核（kernel，执行内核）。
* 预设优先（preset-first）：从家族预设（family preset，预配置的模型家族默认值）和预设工具构建器出发，快速得到稳定基线（baseline）与多模型切换能力。

这两种方式都是一等公民。

<CardGroup cols={2}>
  <Card title="快速开始" icon="rocket" href="/zh/quickstart">
    2 分钟内跑起第一个智能体
  </Card>

  <Card title="构建第一个智能体" icon="code" href="/zh/guides/build-your-first-agent">
    按步骤理解状态、工具、运行和追踪记录（trace）
  </Card>

  <Card title="教程课程" icon="graduation-cap" href="/zh/tutorials">
    通过四节课程式教程学习 QitOS 的智能体设计方法
  </Card>

  <Card title="核心概念" icon="book" href="/zh/concepts/agent-module">
    理解 AgentModule、Engine、State、Tools 与追踪记录
  </Card>

  <Card title="API 参考" icon="rectangle-terminal" href="/zh/reference/api">
    查看公开 Python API 与 CLI
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="研究优先路径" icon="flask" href="/zh/guides/build-your-first-agent">
    手写提示词、解析器、协议与工具面，直接理解内核。
  </Card>

  <Card title="预设优先路径" icon="shuffle" href="/zh/tutorials/switch-model-families">
    用家族预设在同一个示例里快速切换多个模型家族。
  </Card>
</CardGroup>

## 快速启动

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

  <Step title="设置提供商配置">
    ```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="运行最小编程智能体">
    ```bash theme={null}
    qit demo minimal
    ```
  </Step>

  <Step title="用 qita 查看运行轨迹">
    ```bash theme={null}
    qita board --logdir runs
    ```

    打开 [http://127.0.0.1:8765](http://127.0.0.1:8765)，查看追踪记录、回放（replay）和导出（export）结果。
  </Step>
</Steps>

## QitOS 提供什么

<CardGroup cols={2}>
  <Card title="智能体模式" icon="diagram-project" href="/zh/guides/agent-patterns">
    开箱即用的 ReAct、PlanAct、Tree-of-Thought 和 Reflexion
  </Card>

  <Card title="课程式教程" icon="graduation-cap" href="/zh/tutorials">
    从 ReAct 到代码安全审计智能体的完整进阶路径
  </Card>

  <Card title="可观测性" icon="chart-line" href="/zh/guides/observability">
    内置 `qita` 看板、回放与 HTML 导出
  </Card>

  <Card title="基准测试" icon="trophy" href="/zh/benchmarks/overview">
    在同一个内核上运行 GAIA、Tau-Bench 与 CyBench
  </Card>

  <Card title="Kit 工具箱" icon="toolbox" href="/zh/reference/kit">
    解析器、工具集、记忆、历史、规划器与评估器（critic）
  </Card>
</CardGroup>

## 特色设计

<CardGroup cols={2}>
  <Card title="单一执行内核" icon="cpu" href="/zh/concepts/engine">
    示例、评测与生产型智能体全都运行在同一个 `AgentModule + Engine` 上
  </Card>

  <Card title="协议感知解析" icon="brackets-curly" href="/zh/reference/kit">
    提示词格式与解析器选择是显式设计，而不是隐藏的胶水层
  </Card>

  <Card title="长时运行上下文控制" icon="clock-rotate-left" href="/zh/guides/memory-and-history">
    HistoryPolicy、CompactHistory 与记忆适配器共同处理长时任务
  </Card>

  <Card title="以 qita 为核心的可追溯性" icon="chart-line" href="/zh/guides/observability">
    看板、回放与导出都建立在结构化追踪产物（artifact）之上
  </Card>
</CardGroup>
