@zshuangmu/agenthub 0.4.14 → 0.4.16

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 AgentHub
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 AgentHub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,268 +1,268 @@
-<div align="center">
-
-# 🤖 AgentHub
-
-**OpenClaw Agent 的打包、发布与分发平台**
-
-[![npm version](https://img.shields.io/npm/v/@zshuangmu/agenthub.svg)](https://www.npmjs.com/package/@zshuangmu/agenthub)
-[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
-[![Node: >=18](https://img.shields.io/badge/Node.js->=18-green.svg)](https://nodejs.org/)
-[![GitHub Stars](https://img.shields.io/github/stars/itshaungmu/AgentHub?style=social)](https://github.com/itshaungmu/AgentHub)
-
-**把你调教好的 OpenClaw Agent 变成可复用、可分发、可升级的标准资产**
-
-🌐 **在线演示**: [https://agenthub.cyou](https://agenthub.cyou/)
-
-[English](README.md) | [中文](README_CN.md)
-
-</div>
-
----
-
-## 🎯 AgentHub 是什么？
-
-AgentHub 是一个专为 **OpenClaw** 设计的 Agent 打包与分发平台，类似于：
-- **Docker Hub** 之于 Docker 容器
-- **npm** 之于 Node.js 包
-
-但专注于 **OpenClaw Agent 的分发与复刻**。
-
-### 核心能力
-
-| 能力 | 描述 |
-|------|------|
-| 📦 **一键打包** | 将 Agent 的 personality、memory、skills 打包成标准 Bundle |
-| 🚀 **发布分发** | 发布到本地或远程 Registry，生成可分享链接 |
-| ⚡ **一键安装** | 团队成员通过统一命令安装，复刻完整 Agent 能力 |
-| 🔄 **版本管理** | 完整的升级、回滚、校验支持 |
-
-### 适合谁？
-
-- **✅ OpenClaw 团队用户**: 统一分发、版本管理、团队复用
-- **✅ Agent 创作者**: 打包分享你调教好的 Agent
-- **✅ AI 重度用户**: 快速获得别人调教好的 Agent 能力
-
-### 不适合谁？
-
-- ❌ 非 OpenClaw 用户（当前仅支持 OpenClaw）
-- ❌ 需要 Prompt 收藏夹（请使用专门的 Prompt 工具）
-- ❌ 单个 Skill 分发（请使用 ClawHub）
-
-## 🎯 官方样板 Agent
-
-我们提供了 3 个官方样板 Agent，帮助你快速上手：
-
-| Agent | 描述 | 适用场景 |
-|-------|------|----------|
-| **code-review-assistant** | 代码审查助手 | 代码质量审查、安全漏洞识别 |
-| **team-knowledge-assistant** | 团队知识问答 | 项目信息检索、新员工入职 |
-| **product-doc-writer** | 产品文档撰写 | 功能文档、用户指南、API 文档 |
-
-### 快速试用
-
-```bash
-# 打包任意样板 Agent
-agenthub pack --workspace ./samples/code-review-assistant --config ./samples/code-review-assistant/openclaw.json
-
-# 发布并安装
-agenthub publish ./bundles/code-review-assistant-1.0.0.agent --registry ./.registry
-agenthub install code-review-assistant --registry ./.registry --target-workspace ./workspace
-```
-
-## 📸 Screenshots
-
-![AgentHub Web Interface](./docs/image.png)
-
-## 🚀 3 步上手
-
-### 第一步：安装
-
-```bash
-# 通过 npm 全局安装
-npm install -g @zshuangmu/agenthub
-
-# 或克隆源码
-git clone https://github.com/itshaungmu/AgentHub.git
-cd AgentHub && npm install && npm link
-```
-
-### 第二步：打包并发布你的 Agent
-
-```bash
-# 1. 打包你的 OpenClaw workspace
-agenthub pack --workspace ./my-workspace --config openclaw.json
-
-# 或指定版本号
-agenthub pack --workspace ./my-workspace --config openclaw.json --version 2.0.0
-
-# 2. 发布到 Registry
-agenthub publish ./bundles/my-agent.agent --registry ./.registry
-```
-
-### 第三步：团队成员安装使用
-
-```bash
-# 团队成员一键安装
-agenthub install my-agent --registry ./.registry --target-workspace ./workspace
-
-# 或启动 Web 界面浏览
-agenthub serve --registry ./.registry --port 3000
-```
-
-访问 http://localhost:3000 查看你的 Agent！
-
-### 🎯 试用样板 Agent
-
-我们提供了一个官方样板 Agent，帮助你快速体验：
-
-```bash
-# 1. 克隆仓库
-git clone https://github.com/itshaungmu/AgentHub.git
-cd AgentHub
-
-# 2. 打包样板 Agent
-agenthub pack --workspace ./samples/code-review-assistant --config ./samples/code-review-assistant/openclaw.json
-
-# 3. 发布到本地 Registry
-agenthub publish ./bundles/code-review-assistant-1.0.0.agent --registry ./.registry
-
-# 4. 安装到你的 workspace
-agenthub install code-review-assistant --registry ./.registry --target-workspace ./my-workspace
-
-# 5. 校验安装
-agenthub verify code-review-assistant --registry ./.registry --target-workspace ./my-workspace
-```
-
----
-
-## 📖 命令文档
-
-### CLI 命令
-
-| 命令 | 描述 |
-|------|------|
-| `pack` | 打包 workspace 为 Agent Bundle（支持 `--version` 指定版本） |
-| `publish` | 发布到本地 Registry |
-| `publish-remote` | 发布到远程服务器 |
-| `search` | 搜索 Registry 中的 Agent |
-| `info` | 查看 Agent 详情 |
-| `install` | 安装 Agent 到 workspace |
-| `list` | 列出已安装的 Agent |
-| `uninstall` | 卸载已安装的 Agent |
-| `verify` | 校验已安装 Agent 是否完整 |
-| `versions` | 查看 Agent 版本历史 |
-| `update` | 更新 Agent 到最新版 |
-| `rollback` | 回滚 Agent 到指定版本 |
-| `stats` | 查看 Agent 统计信息 |
-| `doctor` | 诊断 AgentHub 安装和环境问题 |
-| `serve` | 启动 Web + API 服务 |
-| `api` | 仅启动 API 服务 |
-| `web` | 仅启动 Web 前端 |
-
-### HTTP API
-
-```bash
-# 健康检查
-curl http://localhost:3001/api/health
-
-# 列出所有 Agent
-curl http://localhost:3001/api/agents
-
-# 搜索 Agent
-curl "http://localhost:3001/api/agents?q=react"
-
-# 获取 Agent 详情
-curl http://localhost:3001/api/agents/my-agent
-
-# 下载 Agent Bundle
-curl http://localhost:3001/api/agents/my-agent/download
-
-# 获取统计信息
-curl http://localhost:3001/api/stats
-
-# 获取下载排行
-curl "http://localhost:3001/api/stats/ranking?limit=10"
-
-# 发布 Agent (POST)
-curl -X POST http://localhost:3001/api/publish -H "Content-Type: application/json" -d '{"slug":"my-agent","version":"1.0.0"}'
-
-# 上传发布 Agent (POST)
-curl -X POST http://localhost:3001/api/publish-upload -H "Content-Type: application/json" -d '{"bundleData":"..."}'
-```
-
-### AI 自动发现
-
-让你的 AI 助手自动发现可用的 Agent：
-
-```bash
-curl http://localhost:3001/api/skills/agenthub-discover
-```
-
-## 📚 教程文档
-
-| 教程 | 描述 |
-|------|------|
-| [3 步复刻 Agent](./docs/quick-start-3-steps.md) | 10 分钟快速上手指南 |
-| [团队分发指南](./docs/team-distribution-guide.md) | 如何把团队 Agent 标准化分发 |
-| [常见问题 FAQ](./docs/faq.md) | 常见问题解答 |
-
-## 🏗️ 架构
-
-```
-┌─────────────────┐     pack      ┌─────────────────┐    publish    ┌─────────────────┐
-│   OpenClaw      │  ──────────►  │    Bundle       │  ──────────►  │    Registry     │
-│   Workspace     │               │   (*.agent)     │               │   (.registry)   │
-└─────────────────┘               └─────────────────┘               └─────────────────┘
-                                                                          │
-                                          ┌───────────────────────────────┘
-                                          │
-                                          ▼
-                                  ┌─────────────────┐
-                                  │   AgentHub      │
-                                  │   Web + API     │
-                                  └─────────────────┘
-```
-
-## 🧪 开发
-
-```bash
-# 运行测试
-npm test
-
-# 启动开发服务器
-node src/cli.js serve --registry ./.registry
-```
-
-## 🐳 Docker 部署
-
-```bash
-# 生产环境启动（容器内）
-NODE_ENV=production node src/cli.js serve --registry ./.registry --port 3000 --host 0.0.0.0
-```
-
-## 🤝 贡献
-
-欢迎贡献！请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 了解详情。
-
-- 🐛 [报告 Bug](https://github.com/itshaungmu/AgentHub/issues/new?template=bug_report.md)
-- 💡 [请求功能](https://github.com/itshaungmu/AgentHub/issues/new?template=feature_request.md)
-- 🔧 [提交 PR](https://github.com/itshaungmu/AgentHub/pulls)
-
-## 📄 许可证
-
-[MIT License](LICENSE) © AgentHub Team
-
-## 🙏 致谢
-
-- 为 [OpenClaw](https://github.com/openclaw) 生态系统构建
-- 灵感来自 npm 和 Docker Hub
-
----
-
-<div align="center">
-
-**[⬆ 返回顶部](#agenthub)**
-
-Made with ❤️ by the AgentHub Team
-
-</div>
+<div align="center">
+
+# 🤖 AgentHub
+
+**Packaging, Publishing & Distribution Platform for OpenClaw Agents**
+
+[![npm version](https://img.shields.io/npm/v/@zshuangmu/agenthub.svg)](https://www.npmjs.com/package/@zshuangmu/agenthub)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Node: >=18](https://img.shields.io/badge/Node.js->=18-green.svg)](https://nodejs.org/)
+[![GitHub Stars](https://img.shields.io/github/stars/itshaungmu/AgentHub?style=social)](https://github.com/itshaungmu/AgentHub)
+
+**Turn your well-trained OpenClaw Agent into reusable, distributable, and upgradable standard assets**
+
+🌐 **Live Demo**: [https://agenthub.cyou](https://agenthub.cyou/)
+
+[English](README.md) | [中文](README_CN.md)
+
+</div>
+
+---
+
+## 🎯 What is AgentHub?
+
+AgentHub is a packaging and distribution platform designed specifically for **OpenClaw**, similar to:
+- **Docker Hub** for Docker containers
+- **npm** for Node.js packages
+
+But focused on **OpenClaw Agent distribution and replication**.
+
+### Core Capabilities
+
+| Capability | Description |
+|------------|-------------|
+| 📦 **One-Click Packaging** | Package Agent's personality, memory, and skills into a standard Bundle |
+| 🚀 **Publish & Distribute** | Publish to local or remote Registry, generate shareable links |
+| ⚡ **One-Click Install** | Team members install via unified command, replicate complete Agent capabilities |
+| 🔄 **Version Management** | Full support for upgrades, rollbacks, and verification |
+
+### Who is it for?
+
+- **✅ OpenClaw Team Users**: Unified distribution, version management, team reuse
+- **✅ Agent Creators**: Package and share your well-trained Agents
+- **✅ AI Power Users**: Quickly acquire Agent capabilities trained by others
+
+### Who is it NOT for?
+
+- ❌ Non-OpenClaw users (currently only supports OpenClaw)
+- ❌ Those needing a Prompt collection (please use dedicated Prompt tools)
+- ❌ Single Skill distribution (please use ClawHub)
+
+## 🎯 Official Sample Agents
+
+We provide 3 official sample Agents to help you get started quickly:
+
+| Agent | Description | Use Cases |
+|-------|-------------|-----------|
+| **code-review-assistant** | Code Review Assistant | Code quality review, security vulnerability identification |
+| **team-knowledge-assistant** | Team Knowledge Q&A | Project information retrieval, new employee onboarding |
+| **product-doc-writer** | Product Documentation Writer | Feature docs, user guides, API documentation |
+
+### Quick Try
+
+```bash
+# Package any sample Agent
+agenthub pack --workspace ./samples/code-review-assistant --config ./samples/code-review-assistant/openclaw.json
+
+# Publish and install
+agenthub publish ./bundles/code-review-assistant-1.0.0.agent --registry ./.registry
+agenthub install code-review-assistant --registry ./.registry --target-workspace ./workspace
+```
+
+## 📸 Screenshots
+
+![AgentHub Web Interface](./docs/image.png)
+
+## 🚀 3 Steps to Get Started
+
+### Step 1: Installation
+
+```bash
+# Install globally via npm
+npm install -g @zshuangmu/agenthub
+
+# Or clone from source
+git clone https://github.com/itshaungmu/AgentHub.git
+cd AgentHub && npm install && npm link
+```
+
+### Step 2: Package and Publish Your Agent
+
+```bash
+# 1. Package your OpenClaw workspace
+agenthub pack --workspace ./my-workspace --config openclaw.json
+
+# Or specify a version number
+agenthub pack --workspace ./my-workspace --config openclaw.json --version 2.0.0
+
+# 2. Publish to Registry
+agenthub publish ./bundles/my-agent.agent --registry ./.registry
+```
+
+### Step 3: Team Members Install and Use
+
+```bash
+# Team members install with one click
+agenthub install my-agent --registry ./.registry --target-workspace ./workspace
+
+# Or start the Web interface to browse
+agenthub serve --registry ./.registry --port 3000
+```
+
+Visit http://localhost:3000 to see your Agent!
+
+### 🎯 Try Sample Agents
+
+We provide an official sample Agent for quick experience:
+
+```bash
+# 1. Clone the repository
+git clone https://github.com/itshaungmu/AgentHub.git
+cd AgentHub
+
+# 2. Package the sample Agent
+agenthub pack --workspace ./samples/code-review-assistant --config ./samples/code-review-assistant/openclaw.json
+
+# 3. Publish to local Registry
+agenthub publish ./bundles/code-review-assistant-1.0.0.agent --registry ./.registry
+
+# 4. Install to your workspace
+agenthub install code-review-assistant --registry ./.registry --target-workspace ./my-workspace
+
+# 5. Verify installation
+agenthub verify code-review-assistant --registry ./.registry --target-workspace ./my-workspace
+```
+
+---
+
+## 📖 Command Documentation
+
+### CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `pack` | Package workspace as Agent Bundle (supports `--version` to specify version) |
+| `publish` | Publish to local Registry |
+| `publish-remote` | Publish to remote server |
+| `search` | Search Agents in Registry |
+| `info` | View Agent details |
+| `install` | Install Agent to workspace |
+| `list` | List installed Agents |
+| `uninstall` | Uninstall an installed Agent |
+| `verify` | Verify installed Agent integrity |
+| `versions` | View Agent version history |
+| `update` | Update Agent to latest version |
+| `rollback` | Rollback Agent to specified version |
+| `stats` | View Agent statistics |
+| `doctor` | Diagnose AgentHub installation and environment issues |
+| `serve` | Start Web + API services |
+| `api` | Start API service only |
+| `web` | Start Web frontend only |
+
+### HTTP API
+
+```bash
+# Health check
+curl http://localhost:3001/api/health
+
+# List all Agents
+curl http://localhost:3001/api/agents
+
+# Search Agents
+curl "http://localhost:3001/api/agents?q=react"
+
+# Get Agent details
+curl http://localhost:3001/api/agents/my-agent
+
+# Download Agent Bundle
+curl http://localhost:3001/api/agents/my-agent/download
+
+# Get statistics
+curl http://localhost:3001/api/stats
+
+# Get download ranking
+curl "http://localhost:3001/api/stats/ranking?limit=10"
+
+# Publish Agent (POST)
+curl -X POST http://localhost:3001/api/publish -H "Content-Type: application/json" -d '{"slug":"my-agent","version":"1.0.0"}'
+
+# Upload and publish Agent (POST)
+curl -X POST http://localhost:3001/api/publish-upload -H "Content-Type: application/json" -d '{"bundleData":"..."}'
+```
+
+### AI Auto-Discovery
+
+Let your AI assistant automatically discover available Agents:
+
+```bash
+curl http://localhost:3001/api/skills/agenthub-discover
+```
+
+## 📚 Tutorial Documentation
+
+| Tutorial | Description |
+|----------|-------------|
+| [3 Steps to Replicate Agent](./docs/quick-start-3-steps.md) | 10-minute quick start guide |
+| [Team Distribution Guide](./docs/team-distribution-guide.md) | How to standardize team Agent distribution |
+| [FAQ](./docs/faq.md) | Frequently asked questions |
+
+## 🏗️ Architecture
+
+```
+┌─────────────────┐     pack      ┌─────────────────┐    publish    ┌─────────────────┐
+│   OpenClaw      │  ──────────►  │    Bundle       │  ──────────►  │    Registry     │
+│   Workspace     │               │   (*.agent)     │               │   (.registry)   │
+└─────────────────┘               └─────────────────┘               └─────────────────┘
+                                                                          │
+                                          ┌───────────────────────────────┘
+                                          │
+                                          ▼
+                                  ┌─────────────────┐
+                                  │   AgentHub      │
+                                  │   Web + API     │
+                                  └─────────────────┘
+```
+
+## 🧪 Development
+
+```bash
+# Run tests
+npm test
+
+# Start development server
+node src/cli.js serve --registry ./.registry
+```
+
+## 🐳 Docker Deployment
+
+```bash
+# Production startup (inside container)
+NODE_ENV=production node src/cli.js serve --registry ./.registry --port 3000 --host 0.0.0.0
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+- 🐛 [Report a Bug](https://github.com/itshaungmu/AgentHub/issues/new?template=bug_report.md)
+- 💡 [Request a Feature](https://github.com/itshaungmu/AgentHub/issues/new?template=feature_request.md)
+- 🔧 [Submit a PR](https://github.com/itshaungmu/AgentHub/pulls)
+
+## 📄 License
+
+[MIT License](LICENSE) © AgentHub Team
+
+## 🙏 Acknowledgments
+
+- Built for the [OpenClaw](https://github.com/openclaw) ecosystem
+- Inspired by npm and Docker Hub
+
+---
+
+<div align="center">
+
+**[⬆ Back to Top](#agenthub)**
+
+Made with ❤️ by the AgentHub Team
+
+</div>