badlogic/pi-mono - 项目详情

项目介绍快速开始学习路径项目截图 1 贡献者 104 增长趋势代码统计生态关系项目时间线项目竞品依赖分析上榜历史

学习路径指南

难度等级

初级

预计时长

3-5小时

适合人群

对AI智能体开发感兴趣的前端/Node.js开发者，具备基础的TypeScript和命令行操作能力

学习目标：学会使用pi-mono项目中的核心工具，包括调用多厂商LLM API、创建简单的AI智能体，以及通过CLI管理GPU部署

前置知识

TypeScript基础熟悉

项目使用TypeScript开发，需要能理解基本的类型定义和模块导入

Node.js与npm 熟悉

需要安装Node.js环境，使用npm管理依赖和运行脚本

命令行操作了解

需要运行CLI命令和脚本

Git基础了解

需要克隆仓库和查看代码

学习步骤

环境准备与项目概览

30分钟

安装开发环境

确保已安装Node.js（建议v18+）和Git，克隆项目仓库：git clone https://github.com/badlogic/pi-mono.git

可以使用node -v和npm -v检查版本

探索项目结构

查看根目录下的README.md和packages文件夹，了解各个子包的功能

重点关注@mariozechner/pi-ai（LLM API）和@mariozechner/pi-coding-agent（编码智能体）

安装依赖

在项目根目录运行npm install安装所有依赖包

依赖较多，可能需要一些时间

快速体验核心功能

1小时

运行构建检查

按照README提示，先运行npm run build，然后运行npm run check

注意顺序：必须先build再check，因为web-ui包需要依赖的.d.ts文件

体验编码智能体

进入packages/coding-agent目录，查看其README，尝试运行基本的CLI命令

这是项目的亮点功能，可以先了解其基本用法，不一定需要立即配置所有API密钥

查看示例代码

在各个包的src目录中寻找示例或测试文件，了解基本API调用方式

从pi-ai包的测试文件开始，看如何调用不同厂商的LLM

动手实践第一个智能体

1.5小时

配置LLM API密钥

选择一家LLM提供商（如OpenAI），获取API密钥，在代码中配置pi-ai客户端

可以从简单的环境变量配置开始，参考pi-ai包的文档

创建简单的对话智能体

使用pi-agent-core创建一个能调用工具（如获取天气、计算）的基础智能体

先实现一个简单的工具函数，让智能体学习调用它

运行并测试智能体

编写一个简单的脚本，启动智能体并进行对话测试

从控制台输入输出开始，逐步增加复杂度

探索高级功能与部署

1小时

了解TUI库

查看pi-tui包的示例，了解如何创建终端用户界面

可以尝试运行现有的TUI示例，观察差分渲染效果

学习Pod管理

阅读pi-pods包的README，了解如何管理vLLM在GPU Pod上的部署

如果暂时没有GPU环境，可以先了解CLI命令结构

查看贡献指南

阅读CONTRIBUTING.md和AGENTS.md，了解项目开发规范

注意项目对人和AI智能体的贡献都有明确规则

常见错误与避坑指南

未按顺序运行npm run build和npm run check

严格按照README提示：先build生成类型定义文件，再运行check

未正确配置LLM API密钥

确保API密钥以正确的方式（环境变量或配置文件）传递给pi-ai客户端

忽略包之间的依赖关系

注意各包通过@mariozechner/前缀相互引用，修改代码时考虑依赖影响

直接修改node_modules中的代码

所有修改都应在packages目录下的对应包中进行，然后重新构建

下一步探索

深入探索pi-coding-agent的完整功能并集成到工作流中；学习使用pi-pods管理自己的LLM部署；为项目贡献代码或文档，参与开源协作；基于pi-agent-core开发更复杂的多智能体系统