1 line
11 KiB
JSON
1 line
11 KiB
JSON
{"repo": "anan1213095357/pipiclaw", "files": {"README.md": {"37a631396f7267490ab94db43cb66676bab8596f": {"t": 1785674231.186613, "n": 7375, "h": "122a5428f40c89fb", "c": "# <div align=\"left\" style=\"display: flex; align-items: center; line-height: 1.2; gap: 8px;\"><img src=\"./IMG_0868.png\" alt=\"PiPiClaw Logo\" width=\"40\" /> <span style=\"font-size: 32px; font-weight: bold;\">PiPiClaw - 皮皮虾智能机器人 </span> </div>\n\n<div align=\"center\">\n\n<img src=\"./IMG_0868.png\" alt=\"PiPiClaw Logo\" width=\"120\" />\n\n\n\n\n\n\n\n\n**让 AI 成为你的全能智能管家，原生对接 Skill-Hub 一万+ 生态技能**\n\n**点击链接加入群聊【皮皮虾企鹅群】：https://qm.qq.com/q/94ufOsyhZ6**\n\n**🌐 语言切换 | Language:** [中文](README.md) | [English](README_EN.md)\n\n</div>\n\n> 🏆 **打包后仅 ~2 MB** —— 全网最小的本地 AI 智能体，单文件发布、秒级启动，插U盘就能跑。\n\n---\n\n## 📖 项目简介\n\n**PiPiClaw (皮皮虾)** 是一款运行在你自己的设备上的个人 AI 智能管家，基于 OpenAI 接口规范，默认示例使用 Qwen，但也可对接任何兼容 OpenAI 协议的 LLM（如 OpenAI/Azure OpenAI、通义千问、DeepSeek、Moonshot、SiliconFlow、Together 等）。通过终端和内置 Web 控制台，它能在 Windows、macOS、Linux 上陪伴你的工作流，实时渲染由你控制的命令与任务画面——网关只是管理入口，真正执行的是在你机器上常驻的助手本体。\n\n- 不止运维：它是全能的本地智能体，能编排开发、自动化、数据处理、信息检索等任意任务。\n- 原生对接 Skill-Hub，一键搜索并安装 10,000+ 生态技能，无限扩展能力版图。\n\n如果你想要一个像本地助手一样、速度快、始终在线的AI 助手，PiPiClaw 正好契合这一需求。\n\n> 推荐设置：直接在终端运行 `dotnet run`，首次启动会引导你完成 API Key、模型与 Web 控制台的配置（支持任意 OpenAI 协议兼容的服务）；也可以用自包含 AOT 发布（`dotnet publish -c Release -r win-x64|osx-x64|linux-x64 --self-contained true`），在 macOS、Linux、Windows（含 WSL2）上即装即用。全新安装可以从下方「快速开始」走起。\n\n<div align=\"center\">\n <img src=\"./IMG_0870.png\" alt=\"PiPiClaw 运行效果预览\" width=\"720\" />\n</div>\n\n## 🖥️ 界面预览\n\n<div align=\"center\">\n <img src=\"./desktop-screenshot.png\" alt=\"PiPiClaw 桌面端运行界面\" width=\"49%\" />\n <img src=\"./settings-llm.png\" alt=\"PiPiClaw 多模型设置（OpenAI 协议兼容，支持多家 LLM）\" width=\"49%\" />\n</div>\n\n<div align=\"center\">\n <img src=\"./mobile-layout.png\" alt=\"PiPiClaw 移动端自适应布局\" width=\"32%\" />\n</div>\n\n> 桌面端设置页可自由添加任意 OpenAI 协议兼容的模型与 Endpoint，轻松切换 Qwen、DeepSeek、Moonshot、OpenAI/Azure 等不同 LLM。\n\n---\n\n## ✨ 核心功能\n\n| 功能 | 描述 |\n|------|------|\n| 🔧 **命令执行** | 跨平台终端命令执行 (ls, git, npm, docker, systemctl 等) |\n| 📄 **文件读取** | 智能读取文本、代码、配置文件内容，自动检测编码 (UTF-8/GBK) |\n| ✍️ **文件写入** | 自动生成代码、配置文件并写入本地，支持局部修改 |\n| 🖼️ **图片分析** | 支持本地截图、照片的识别与分析 (Base64 编码) |\n| 🔍 **内容搜索** | 在指定目录下搜索包含特定关键字的文件 (函数名、变量名、类名等) |\n| ⏰ **定时任务** | 支持一次性/周期性任务调度，持久化存储，自动执行 |\n| 🧩 **技能扩展** | 支持从 Skill-Hub 搜索和安装扩展技能，无限拓展能力 |\n| 🌐 **Web 控制台** | 内置轻量级 Web UI (端口 5050)，支持浏览器远程操控 |\n| 🧠 **记忆管理** | 多轮对话上下文记忆，任务完成后自动清理节省 Token |\n| 🔐 **权限处理** | 智能 sudo 提权拦截，自动处理密码输入 (非 Windows) |\n\n---\n\n## 🚀 快速开始\n\n### 前置要求\n\n- [.NET 10.0 SDK](https://dotnet.microsoft.com/download) 或更高版本\n- 任意 **OpenAI 协议兼容** 的 API Key（示例：OpenAI/Azure OpenAI、阿里云 DashScope、DeepSeek、Moonshot、SiliconFlow、Together AI 等）\n\n### 安装与运行\n\n```bash\n# 克隆项目\ngit clone https://github.com/anan1213095357/PiPiClaw.git\ncd PiPiClaw\n\n# 还原依赖\ndotnet restore\n\n# 运行项目\ndotnet run\n```\n\n首次运行时会自动生成 `appsettings.json` 配置文件，按提示输入 API Key 即可。\n\n### 发布为独立可执行文件\n\n```bash\n# 发布 AOT 编译版本（单文件、高性能）\ndotnet publish -c Release -r win-x64 --self-contained true\ndotnet publish -c Release -r osx-x64 --self-contained true\ndotnet publish -c Release -r linux-x64 --self-contained true\n```\n\n---\n\n## ⚙️ 配置说明\n\n### 配置文件 (appsettings.json)\n\n> 首次运行会自动生成，内置 `Models` 列表可在 Web 控制台中增删并下拉切换。\n\n```json\n{\n \"Models\": [\n {\n \"ApiKey\": \"sk-your-actual-api-key-here\",\n \"Model\": \"qwen3.5-plus\",\n \"Endpoint\": \"https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions\"\n }\n ],\n \"SudoPassword\": \"\",\n \"WebPort\": 5050\n}\n```\n\n| 配置项 | 说明 |\n|--------|------|\n| `Models` | 模型配置列表，首个为默认模型，Web UI 下拉实时切换 |\n| `Models[].ApiKey` | 任意 OpenAI/兼容接口的 API Key（示例为 DashScope） |\n| `Models[].Model` | 使用的 AI 模型 (默认示例 qwen3.5-plus，可填 DeepSeek/Moonshot/GPT 等) |\n| `Models[].Endpoint` | OpenAI 协议兼容的 API 端点地址 |\n| `SudoPassword` | (可选) Linux/macOS 自动提权密码 |\n| `WebPort` | Web 控制台端口 (默认 5050) |\n\n### 环境变量方式\n\n```bash\n# macOS / Linux\nexport ApiKey=\"sk-your-api-key-here\"\nexport Model=\"qwen3.5-plus\"\nexport Endpoint=\"https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions\"\nexport WebPort=5050\nexport SudoPassword=\"\"\n\n# Windows PowerShell\n$env:ApiKey=\"sk-your-api-key-here\"\n$env:Model=\"qwen3.5-plus\"\n$env:Endpoint=\"https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions\"\n$env:WebPort=\"5050\"\n$env:SudoPassword=\"\"\n```\n\n> 环境变量名与配置字段一致（区分大小写），适合容器或临时覆盖。\n\n> 以上为 DashScope 示例，请将 `Model` 与 `Endpoint` 替换为你所使用的 OpenAI 兼容服务（OpenAI/Azure/DeepSeek/Moonshot 等）的地址。\n\n---\n\n## 💡 使用示例\n\n启动 PiPiClaw 后，你可以输入各种自然语言指令：\n\n### 基础操作\n```\n> 帮我扫描一下当前目录，看有没有 C# 相关的源码文件\n\n> 读取 package.json 的内容并分析依赖\n\n> 执行 git status 查看当前仓库状态\n\n> 帮我查一下系统当前的内存占用情况，并把结果写进 memory_log.txt\n```\n\n### 文件操作\n```\n> 创建一个名为 config.json 的配置文件，包含数据库连接信息\n\n> 把 main.cs 里的所有 Console.WriteLine 替换成 Debug.WriteLine\n```\n\n### 定时任务\n```\n> 每天下午 3 点，帮我屏幕截图看一下我在干什么\n\n> 每隔 30 分钟检查一次 CPU 使用率，超过 80% 就记录到日志\n```\n\n### 技能扩展\n```\n> 帮我搜索 weather 相关的技能\n\n> 安装 calendar 技能\n```\n\n---\n\n## 🏗️ 项目结构\n\n```\nPiPiClaw/\n├── Program.cs # 主程序入口 (全部逻辑)\n├── PiPiClaw.csproj # 项目配置文件\n├── README.md # 项目说明文档 (中文)\n├── README_EN.md # 项目说明文档 (英文)\n├── .gitignore # Git 忽略规则\n├── appsettings.json # 配置文件（本地使用，不提交）\n├── appsettings.example.json # 配置模板（可提交）\n├── Properties/ # 项目属性配置\n├── bin/ # 编译输出目录\n├── obj/ # 临时构建文件\n├── logs/ # 日志目录\n├── skills/ # 扩展技能目录 (自动创建)\n├── pi_history.json # 对话记忆存档\n└── pi_scheduled_tasks.json # 定时任务存档\n```\n\n---\n\n## 🔬 技术栈\n\n| 组件 | 技术选型 |\n|------|----------|\n| **运行时** | .NET 10.0 |\n| **编译优化** | AOT (Ahead-of-Time) 编译 |\n| **AI 模型** | OpenAI 协议兼容 LLM（示例：Qwen、DeepSeek、Moonshot、OpenAI/Azure 等） |\n| **HTTP 客户端** | System.Net.Http |\n| **JSON 处理** | System.Text.Json |\n| **编码支持** | UTF-8 / GBK 自动检测 |\n\n### 项目特性\n\n- ✅ **AOT 编译** - 更小的体积、更快的启动速度\n- ✅ **极致轻量** - 发布包仅 ~2 MB，随身携带、秒开即用\n- ✅ **跨平台** - 支持 Windows、Linux、macOS\n- ✅ **流式对话** - 支持多轮上下文对话\n- ✅ **工具调用** - 10+ 内置工具智能调度\n- ✅ **定时调度** - 持久化任务队列，自动循环执行\n- ✅ **Web UI** - 内置 HTTP 服务器，浏览器远程操控\n- ✅ **技能系统** - 支持在线搜索和安装扩展技能\n- ✅ **错误处理** - 完善的异常捕获与提示\n- ✅ **安全配置** - API Key 与代码分离，支持环境变量\n- ✅ **日志压缩** - 自动折叠相似日志行，节省 Token\n\n---\n\n## 🌐 Web 控制台\n\nPiPiClaw 内置轻量级 Web UI，启动后自动监听 `http://localhost:5050`\n\n**功能特性：**\n- 📱 响应式设计，支持手机/平板访问\n- 🎨 赛博朋克风格界面\n- 📡 实时流式输出工具调用过程\n- ⏰ 定时任务可视化查看\n- 🔧 在线配置 / 切换多模型（API Key / 模型下拉）\n- 📷 左下角二维码，手机扫码即连\n\n---\n\n## 📝 注意事项\n\n1. **API Key 安全**: `appsettings.json` 已加入 `.gitignore`，请勿手动提交包含真实 Key 的文件\n2. **命令执行权限**: 工具执行的命令具有与当前用户相同的权限，请谨慎操作\n3. **网络依赖**: 需要稳定的网络连接以调用 AI 服务\n4. **Token 限制**: 大文件读取会自动截断，防止 Token 溢出\n5. **文件修改**: 修改现有文件时，请确保提供精确的 old_content 进行替换\n6. **Windows 提权**: Windows 环境下无法自动处理 sudo，请以管理员身份运行程序\n\n---\n\n## 🤝 贡献指南\n\n欢迎提交 Issue 和 Pull Request！\n\n1. Fork 本项目\n2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)\n3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)\n4. 推送到分支 (`git push origin feature/AmazingFeature`)\n5. 开启 Pull Request\n\n---\n\n## 📄 许可证\n\n本项目采用 [MIT 许可证](LICENSE) 开源。\n\n---\n\n<div align=\"center\">\n\n<img src=\"./IMG_0868.png\" alt=\"PiPiClaw Logo\" width=\"26\" style=\"vertical-align: middle; margin-right: 6px;\" /> Made with ❤️ by 奶茶叔叔\n\n如果这个项目对你有帮助，请给一个 ⭐ Star 支持一下！\n\n</div>\n"}}}} |