diff --git a/.github/workflows/release-publish.yml b/.github/workflows/release-publish.yml new file mode 100644 index 00000000..94f7d0c6 --- /dev/null +++ b/.github/workflows/release-publish.yml @@ -0,0 +1,54 @@ +name: Release Publish + +on: + push: + branches: + - main + +env: + IMAGE_NAME: bankofai/docs + +jobs: + build-and-publish: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Log in to Docker Hub + env: + DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }} + DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }} + run: | + echo "$DOCKERHUB_TOKEN" | docker login -u "$DOCKERHUB_USERNAME" --password-stdin + + - name: Get version from package.json + id: version + run: echo "VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT + + - name: Set Docker tags + id: meta + run: | + echo "tags<> $GITHUB_OUTPUT + echo "${{ env.IMAGE_NAME }}:${{ steps.version.outputs.VERSION }}" >> $GITHUB_OUTPUT + echo "EOF" >> $GITHUB_OUTPUT + + - name: Build and push Docker image + uses: docker/build-push-action@v6 + with: + context: . + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + build-args: | + APP_ENV=production + cache-from: type=gha + cache-to: type=gha,mode=max + platforms: linux/amd64 diff --git a/docs/llmservice/openclaw/integration-guide.md b/docs/llmservice/openclaw/integration-guide.md index 041277e5..d76a6011 100644 --- a/docs/llmservice/openclaw/integration-guide.md +++ b/docs/llmservice/openclaw/integration-guide.md @@ -128,7 +128,7 @@ After completing the onboarding wizard, you'll need to manually add your Bank of There are two ways to complete the configuration: -- **One-Click Script**: https://docs.ainft.com/reference/openclaw-ainft-integration-one-click-script-tutorial +- **One-Click Script**: [Click here for the tutorial](https://docs.bankofai.io/llmservice/openclaw/one-click-script-tutorial/) - **Manual Configuration**: Follow the instructions below --- diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/llmservice/openclaw/integration-guide.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/llmservice/openclaw/integration-guide.md index 12ec1fd1..60db8a87 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/llmservice/openclaw/integration-guide.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/llmservice/openclaw/integration-guide.md @@ -1,49 +1,57 @@ -# 集成 OpenClaw 与 Bank of AI -## 从零到私人 AI Agent：15 分钟部署 OpenClaw + Bank of AI +# OpenClaw × Bank of AI 集成 +## 从零到私有 AI Agent：15 分钟部署 OpenClaw 与 Bank of AI -OpenClaw（原名 ClawdBot / Moltbot）是一个开源的个人 AI 助手。与云端 SaaS 工具不同，OpenClaw 运行在本地设备上，让你完全掌控数据与工作流程。 +OpenClaw（原名 ClawdBot 或 Moltbot）是一个开源的个人 AI 助手。不同于云端 SaaS 工具，OpenClaw 运行在本地机器上，使你能够完全掌控数据和工作流。你可以通过 WhatsApp、Telegram、Lark、钉钉等熟悉的通讯平台与其交互，用于处理邮件、管理日历、编写代码，甚至自动化你的智能家居。 -你可以通过 WhatsApp、Telegram、Lark、钉钉等消息平台与其交互，用于处理邮件、管理日历、编写代码，甚至自动化智能家居。 +OpenClaw 不仅仅是一个聊天机器人，它是一个真正可执行任务的“Agent”。它具备持久化记忆、访问本地文件系统和互联网的能力，并且可以通过扩展“技能（Skills）”不断增强能力。 -OpenClaw 不只是聊天工具，而是具备实际执行能力的 **AI Agent**，支持： +由于其开源和自托管特性，OpenClaw 吸引了大量开发者和技术爱好者社区。社区已经探索出许多创新用例，从自动化业务流程到管理个人生活，展示了个人 AI 的巨大潜力。 -- 持久化记忆 -- 本地文件访问 -- 互联网访问 -- 技能扩展 - -本指南将带你完成安装、配置，并连接 Bank of AI API，快速搭建属于你的 AI Agent。 +本指南将从零开始带你完成：下载、安装、配置 OpenClaw，并连接 Bank of AI API。最终，你将拥有属于自己的 AI 助手。 --- -# Step 1 获取 Bank of AI API Key +## **Step 1: 获取 Bank of AI API Key** -1. 打开：https://chat.bankofai.io/chat -2. 登录账户 -3. 进入 API Key 管理页面 -4. 创建并复制 API Key +1. 登录 https://chat.bankofai.io/chat +2. 进入 API Key 管理页面并申请你的 api_key --- -# Step 2 准备系统环境 +## **Step 2: 准备系统环境** + +在安装之前，请确保你的系统满足以下基本要求。OpenClaw 适用于类 Unix 系统，同时也可以通过 WSL2 在 Windows 上运行。 | 要求 | 说明 | -|---|---| -| Node.js | ≥ v22 | -| 系统 | macOS / Linux / Windows（WSL2） | -| 包管理 | npm | +|------|------| +| Node.js | 版本 22 或以上 | +| 操作系统 | macOS、Linux、Windows（WSL2） | +| 包管理器 | pnpm（源码编译需要）；标准安装推荐 npm | -检查版本： +检查环境： ```bash node -v ``` -若版本过低，请前往：https://nodejs.org/ +如果版本低于 v22.0.0 或提示“command not found”，请前往官网安装或升级 Node.js： +https://nodejs.org/ --- -# Step 3 安装 OpenClaw +## **Step 3: 安装 OpenClaw** + +OpenClaw 支持多种安装方式。对于初学者，推荐使用官方一行命令安装方式，它会自动完成大部分配置。 + +该方法会自动检测操作系统、安装依赖，并将 openclaw 命令全局可用。 + +macOS / Linux： + +```bash +npm install -g openclaw +``` + +Windows PowerShell： ```bash npm install -g openclaw @@ -51,58 +59,95 @@ npm install -g openclaw --- -## 常见问题 +### **常见问题排查** + +#### **问题 1：Sharp 模块错误** -### Sharp 报错 +在部分系统（尤其是 macOS + Homebrew 安装 libvips）中，可能遇到 sharp 模块报错。可以通过强制安装预编译版本解决： ```bash npm install -g openclaw --force ``` -### 命令找不到 +--- + +#### **问题 2：“Command Not Found”** ```bash -npm config get prefix +openclaw: command not found ``` -例如输出： +运行： -``` -/usr/local +```bash +npm config get prefix ``` -加入环境变量： +如果输出为 `/usr/local`，则说明可执行文件位于 `/usr/local/bin`，需要将其加入 PATH： ```bash export PATH="/usr/local/bin:$PATH" +``` + +然后执行： + +```bash source ~/.zshrc ``` --- -# Step 4 初始化 +## **Step 4: 完成初始化向导** + +安装完成后，初始化向导通常会自动启动。 + +如果没有启动，可以手动执行： ```bash openclaw onboard ``` -操作建议： +向导包括三个部分： + +- **AI Model Configuration（模型配置）** + 会要求填写 API Key + → 暂时选择 **Skip for now** + +- **Communication Channels（通信渠道）** + 选择你要使用的通讯工具（如 Telegram、WhatsApp） + +- **Skills（技能）** + 建议选择 **No**（后续可添加） + +完成后进入 OpenClaw UI。 -- 模型配置：选择 **Skip for now** -- 渠道：可跳过 -- Skills：选择 No +--- + +## **Step 5: 配置 Bank of AI 模型** + +完成初始化后，你需要手动将 Bank of AI 配置添加到 OpenClaw，并设置为默认模型。 + +有两种方式可以完成配置： + +- **One-Click Script（自动脚本方式）** + https://docs.bankofai.io/zh-Hans/llmservice/openclaw/one-click-script-tutorial/ + +- **Manual Configuration（手动配置）** + 按照下面步骤操作 --- -# Step 5 配置 Bank of AI +### **5.1 编辑配置文件** -## 5.1 编辑配置文件 +打开配置文件： ```bash vim ~/.openclaw/openclaw.json ``` -加入： +OpenClaw 启动时会读取该文件加载模型配置。 + +找到 `"models"` 部分，并合并以下 JSON（记得替换 API Key）： ```json { @@ -114,12 +159,30 @@ vim ~/.openclaw/openclaw.json "apiKey": "{BANKOFAI_API_KEY}", "api": "openai-completions", "models": [ - { "id": "gpt-5.2", "name": "gpt-5.2" }, - { "id": "gpt-5-mini", "name": "gpt-5-mini" }, - { "id": "gpt-5-nano", "name": "gpt-5-nano" }, - { "id": "claude-opus-4.6", "name": "claude-opus-4.6" }, - { "id": "claude-sonnet-4.6", "name": "claude-sonnet-4.6" }, - { "id": "claude-haiku-4.5", "name": "claude-haiku-4.5" } + { + "id": "gpt-5.2", + "name": "gpt-5.2" + }, + { + "id": "gpt-5-mini", + "name": "gpt-5-mini" + }, + { + "id": "gpt-5-nano", + "name": "gpt-5-nano" + }, + { + "id": "claude-opus-4.6", + "name": "claude-opus-4.6" + }, + { + "id": "claude-sonnet-4.6", + "name": "claude-sonnet-4.6" + }, + { + "id": "claude-haiku-4.5", + "name": "claude-haiku-4.5" + } ] } } @@ -129,7 +192,9 @@ vim ~/.openclaw/openclaw.json --- -## 5.2 设置默认模型 +### **5.2 设置默认模型** + +在同一个 `openclaw.json` 文件中，找到 `agents`： ```json { @@ -143,7 +208,7 @@ vim ~/.openclaw/openclaw.json --- -## 5.3 重启服务 +### **5.3 重启 Gateway** ```bash openclaw gateway restart @@ -151,78 +216,136 @@ openclaw gateway restart --- -## 5.4 测试 +### **5.4 测试连接** ```bash -openclaw agent --agent main --message "Hello" +openclaw agent --agent main --message "How are you doing today?" ``` +如果返回正常内容，说明连接成功。 + --- -# Step 6 Gateway 与诊断 +## **Step 6: Gateway 与诊断命令** -常用命令： +### **什么是 Gateway？** + +Gateway 是 OpenClaw 的核心服务组件。 | 操作 | 命令 | -|---|---| +|------|------| +| 安装 | openclaw gateway install | | 启动 | openclaw gateway start | | 停止 | openclaw gateway stop | | 重启 | openclaw gateway restart | +| 卸载 | openclaw gateway uninstall | | 状态 | openclaw gateway status | -诊断： +--- + +### **诊断命令** ```bash openclaw doctor ``` +```bash +openclaw gateway status +``` + +如果显示 **Healthy**，说明运行正常。 + --- -# Step 7 启动 +## **Step 7: 启动 OpenClaw** + +你可以通过 Web 界面或终端使用 OpenClaw。 -## Web UI +--- + +### **方式 1：Web Dashboard** ```bash openclaw dashboard ``` -打开： +打开浏览器访问： ``` http://127.0.0.1:18789 ``` +功能包括： + +- 聊天 +- 查看历史 +- 配置模型 +- 查看系统状态 + --- -## 终端 UI +### **方式 2：终端 UI（TUI）** ```bash openclaw tui ``` +常用命令： + +| 命令 | 说明 | +|------|------| +| /status | 查看系统状态 | +| /session `` | 切换会话 | +| /model `` | 切换模型 | +| /help | 查看帮助 | + --- -# Step 8 常用命令 +## **Step 8: 常用命令** + +### 1. 查看模型状态 ```bash openclaw models status +``` + +--- + +### 2. 管理渠道 + +```bash openclaw channels list +``` + +--- + +### 3. 搜索记忆 + +```bash openclaw memory search "keyword" +``` + +--- + +### 4. 查看文档 + +```bash openclaw docs ``` --- -# 完成 +# ✅ 完成 -你已经成功部署： +你已经成功部署了： -**OpenClaw + Bank of AI AI Agent** +**OpenClaw + Bank of AI 私有 AI Agent** -你可以： +现在你可以： -- 自动化流程 -- 接入 Telegram -- 构建 AI 产品 +- 构建自动化工作流 +- 接入 Telegram Bot +- 执行链上操作 +- 构建 AI Agent 产品 -🚀 +🚀 欢迎进入你的个人 AI 基础设施时代 diff --git a/package.json b/package.json index 4bb0d72e..9c576f1b 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,6 @@ { "name": "@x402-tron/docs", + "version": "1.2.2", "description": "x402-tron documentation", "license": "MIT", "scripts": {