
快速上手
这篇教程带你从安装到日常使用,大约 10 分钟。
Peri 是单个静态链接的二进制文件,不需要 Node.js、Python 或任何运行时依赖。
| 平台 | 架构 |
|---|---|
| macOS | x86_64 / Apple Silicon |
| Linux | x86_64 / aarch64 / riscv64 |
| Windows | x86_64 |
打开终端,运行以下命令:
curl -fsSL https://raw.githubusercontent.com/konghayao/peri/main/scripts/install.sh | bashirm https://raw.githubusercontent.com/konghayao/peri/main/scripts/install.ps1 | iex安装完成后,验证一下:
peri --version# 输出类似: peri 0.x.x2. 首次启动
Section titled “2. 首次启动”直接运行 peri,会进入交互式配置向导:
peri向导会引导你完成两件事:
- 选择模型 — 从预设的模型列表中选择,或输入自定义的 OpenAI 兼容 API 端点
- 设置 API Key — 输入对应提供商的 API Key,保存到本地配置文件
配置完成后,你会看到 Peri 的 TUI 界面——流式 Markdown 渲染、状态栏、输入区都在一个终端窗口里。
3. 第一次对话
Section titled “3. 第一次对话”先从简单任务开始。在 Peri 的对话区直接输入:
用 Python 写一个函数,把驼峰命名转成蛇形命名。带上测试用例。Peri 会写出函数和测试,然后直接运行。整个过程大概是这样:
你: 用 Python 写一个函数,把驼峰命名转成蛇形命名。带上测试用例。
Peri: [思考中...]
写好了 `camel_to_snake` 函数,同时写了 4 个测试用例。运行测试:
===== test session starts ===== 4 passed in 0.03s
代码已写入 `snake_case.py`。4. 日常使用
Section titled “4. 日常使用”Peri 适合各种日常编码任务。以下是最常见的三种场景。
把错误信息或堆栈 trace 贴给 Peri,告诉它代码在哪:
src/api/auth.ts 第 42 行报 TypeError: Cannot read properties of undefined,帮我查一下原因并修复。Peri 会读代码、分析原因、编辑文件、跑测试——一轮完成。
描述你想要的结果:
把 src/utils/ 下所有日期处理函数从 moment.js 迁移到 dayjs,保持所有测试通过。Peri 会逐个文件修改,每次改完验证测试。
指向要测的模块:
给 src/services/order.ts 写单元测试,覆盖正常流程和 3 种异常情况。5. 进阶功能速览
Section titled “5. 进阶功能速览”日常用熟了之后,这几个功能能显著提升效率。
一次会话中可以随时切换,不用重启。Peri 预置四个档位(便宜/均衡/强推理等),点击状态栏的模型段即可快速切换档位:
Ctrl+M # 打开 Model 面板,编辑四档配置并切换一个任务要跑很多轮,中间你可能去做别的事:
/goal create "把 src/auth/ 下 5 个文件从回调风格改成 async/await"Peri 在后续每一轮自动提醒自己”这事还没做完”。做完后:
/goal complete详细用法见 管理长任务。
把复杂任务拆成多个子代理并行执行。直接告诉 Peri:
用 ultracode 并行审查我刚改的代码Peri 会把审查、编码、探索分给不同子代理同时跑。详细用法见 并行执行多任务。
6. 下一步
Section titled “6. 下一步”你已经可以用 Peri 完成大部分日常编码。想深入了解某个功能,从这里开始:
- 管理长任务 — 多轮自动化任务推进
- 并行执行多任务 — 任务拆分与并行执行
- 模型档位 — 四档独立配置,一键切换模型与推理强度
- 图片输入 — 截图直接粘贴给 Peri
- 定时任务 — 让 Peri 每天定时干活
- Hooks — 事件驱动的自动化钩子
- 主题 — 自定义终端配色
- MCP 服务器 — 扩展外部工具接入
- CLI 命令参考 — 所有命令速查
遇到问题?先按 Ctrl+S 打开 /status 面板查看运行时状态,或在新的最小会话里复现问题。详见 定位并修复 Bug。