ZPI 文档索引
ZPI 以四工具执行内核和 TypeScript Agent SDK 为基础。提问、联网、子智能体协作、后台命令、记忆、自动标题和任务通知通过系统内置插件按需配置与启停;桌面工作区提供对话、文件、终端与审查界面。
桌面端不支持 Windows,当前主要在 macOS Apple Silicon 上验证。推荐使用 Node.js 24,通过 npx @zpi-dev/desktop 启动桌面应用。需要固定命令时,运行 npm install -g @zpi-dev/desktop,然后使用 zpi-desktop。模型账号在应用设置中配置,应用使用正式版 ZPI 数据目录。
| 主题 | 功能讲解 | 原理剖析 |
|---|---|---|
| 模型与账号 | 接入与配置 | 提供商 · ChatGPT 登录与令牌 · WebSocket · 协议转换 |
| 对话与执行 | 对话操作 | 会话生命周期 · Agent 循环 · 输入队列 · 失败恢复 |
| 项目与任务 | 项目和工作树 | 目录、组织与工作树 |
| 上下文与技能 | 上下文管理 | 压缩与媒体预算 · 指令和技能加载 |
| 自定义命令 | 编写和导入 | 存储、展开与执行 |
| 文件与命令工具 | 四个基础工具 | 读取、编辑与执行机制 |
| 协作与提问 | 辅助对话和子智能体 | 子智能体 · 结构化提问 |
| 后台命令与终端 | 使用方式 | 进程与 PTY 生命周期 |
| 联网搜索 | 搜索与来源 | 请求、限流和图标加载 |
| 记忆 | 短期与长期记忆 | 提取、整合与恢复 |
| 文件与预览 | 浏览和预览 | 文件树和格式渲染 |
| 变更审查 | 查看和回退 | Diff、快照与回退 |
| 面板和浏览器 | 标签与完整视图 | 面板状态和原生视图 |
| 快捷键 | 默认键与改键 | 事件路由和焦点 |
| 界面 | 显示和通知 | 流式渲染与阅读位置 |
| 搜索 | 查找任务和文件 | 索引、分页和高亮 |
| 本地数据 | 备份与恢复 | 业务存储 · 历史与 Worker |
| 诊断 | 故障排查与用量 | 错误、日志和计量 |
| SDK | 脚本接入 | 装配和扩展接口 |
| 插件与 Hook | 插件管理与生效范围 · 钩子配置 | 组件装配、生命周期与运行时隔离 |
| 开发 | 环境与调试 | 启动与构建链路 · Electron 边界 |
| 测试 | 运行和选择测试 | 隔离与清理机制 |
| npm 分发 | 构建与发布 | 产物与原生依赖 |
- 本地阅读文档:
npm run docs(或仓库内npx zpi-docs),默认打开 http://127.0.0.1:4400 - npm 桌面包
- 仓库
快速对话是独立的 zpi-quick-chat CLI 项目,设置 DEEPSEEK_API_KEY 后通过 npx @zpi-dev/quick-chat 启动,需要 Node.js 24 和 Apple Silicon Mac。后端与 ZPI 共用 @zpi-dev/agent-sdk,可通过 npm install @zpi-dev/agent-sdk 接入自己的项目。Agent SDK 保持跨平台,包含 Windows 支持,不受桌面端的平台限制。SDK 使用和支持范围见 agent-sdk。