# Lighter

> 轻量的 TypeScript AI Agent 框架。当前为 Alpha 版本。

从快速开始入手，再按任务查阅指南和 API。

- [Lighter](/zh/docs/): Lighter 是一个用于构建 AI agent 的轻量 TypeScript 框架。它负责模型调用与工具执行之间的循环，让你用少量代码搭建自己的 agent。
- [快速开始](/zh/docs/getting-started/quickstart/): 用一个最小示例，连接模型并获得第一条回复。以下使用 OpenAI，需要 Node.js 22+ 和一个使用 ESM 的 TypeScript 项目。
- [核心概念](/zh/docs/getting-started/concepts/): 理解六个组件，就能掌握 Lighter 的主要用法：Provider、Model、Agent、Message、Tool 和 Hook。
- [配置 Agent](/zh/docs/guides/configuration/): 创建 Agent 时只有 model 必填。按需添加工具、系统提示词和生命周期钩子。
- [添加工具](/zh/docs/guides/tools/): 工具让模型调用你定义的函数。你负责描述工具并实现逻辑，Agent 负责校验参数、执行函数和回传结果。
- [管理消息与对话历史](/zh/docs/guides/conversations/): Lighter 不自动保存对话。每次运行传入已有历史，再把返回的新增消息追加进去，就能继续对话。
- [使用流式输出](/zh/docs/guides/streaming/): 用 stream() 代替 run()，可以在模型生成过程中逐步接收文本。两者执行相同的工具循环。
- [使用生命周期钩子](/zh/docs/guides/hooks/): 钩子让你在特定时机读取或修改请求与结果，适合日志、输入预处理和回复检查。
- [处理错误](/zh/docs/guides/errors/): Agent 用 status 表示运行是否完成。模型或钩子失败时，先检查结果，再读取 error。
- [选择和配置 Provider](/zh/docs/providers/): Provider 负责连接模型服务。更换 Provider 后，仍然通过 Model 和 Agent 使用相同的消息与工具接口。
- [自定义 Provider](/zh/docs/providers/custom/): 接入其他模型服务时，实现 Provider 接口，再传给 new Model(provider)。Agent 不需要了解服务的具体 API。
- [直接调用 Model](/zh/docs/advanced/model/): 如果只需要一次模型调用，或希望自己控制工具执行过程，可以直接使用 Model。
- [运行边界与应用责任](/zh/docs/advanced/limits/): Lighter 负责模型与工具之间的核心循环。应用需要根据任务补充存储、运行限制、权限与监控。
- [Agent API](/zh/docs/reference/agent/): 本页对应 Lighter 0.1.0。用法见配置 Agent与流式输出。
- [Model 与 Provider API](/zh/docs/reference/model-and-providers/): 用法见直接调用 Model、内置 Provider与自定义 Provider。
- [Messages API](/zh/docs/reference/messages/): 消息通过 role 区分用途。用法见管理对话历史。
- [Tool API](/zh/docs/reference/tools/): Tool 封装参数校验、函数执行和工具结果。用法见添加工具。
- [Hooks API](/zh/docs/reference/hooks/): 四种钩子使用相同的构造方式。运行示例见使用生命周期钩子。
- [Errors API](/zh/docs/reference/errors/): 用法见处理错误。内置 Provider 用 ModelError 表示可识别的模型调用错误。

[完整文档](/zh/llms-full.txt)