返回首頁AI 自動化

Clawbot 開發者指南|GitHub 開源專案、API 文件與社群資源

14 min 分鐘閱讀
#clawbot#openclaw#github#api#開源#開發者#rest api#cli#社群#moltbot

Clawbot 開發者指南|GitHub 開源專案、API 文件與社群資源

Clawbot 開發者指南|GitHub 開源專案、API 文件與社群資源

Clawbot 的開源策略

Clawbot 不只是一個產品,它也是一個開源專案。如果你是開發者,想自己修改功能、貢獻程式碼、或把 Clawbot 整合進自家系統,這篇指南會幫你快速上手。

Clawbot 的基礎介紹請見 Clawbot / OpenClaw 完整指南,了解產品定位與核心功能後再來看開發文件。

GitHub Repository 結構

Clawbot 的 GitHub 組織下有多個 Repo,各自負責不同模組:

Repository用途語言
clawbot/core核心引擎,AI Agent 邏輯TypeScript
clawbot/browser-relayBrowser Relay 模組TypeScript
clawbot/dashboardDashboard 前端介面React + TypeScript
clawbot/plugins官方與社群 PluginTypeScript / Python
clawbot/docs官方文件原始碼Markdown
clawbot/cliCLI 命令列工具TypeScript

主要目錄結構(以 clawbot/core 為例):

clawbot/core/
├── src/
│   ├── agent/          # AI Agent 邏輯
│   ├── browser/        # 瀏覽器控制層
│   ├── scheduler/      # 任務排程
│   ├── api/            # REST API 端點
│   └── utils/          # 共用工具
├── tests/              # 測試程式碼
├── docs/               # 內部文件
├── package.json
├── tsconfig.json
└── README.md

授權模式與使用條款

Clawbot 的核心引擎和 Browser Relay 採用 Apache 2.0 授權,你可以:

  • 自由使用、修改、散佈
  • 用於商業專案
  • 不需要開源你的修改(但建議回饋社群)

注意:部分進階功能(如企業級 Dashboard、優先技術支援)屬於商業版,不包含在開源授權中。

開源 vs 商業版差異

功能開源版(免費)商業版(付費)
AI Agent 核心
Browser Relay
Dashboard基礎版完整版(含團隊管理)
Plugin 系統
API 存取✅(有速率限制)✅(更高速率限制)
技術支援GitHub Issues優先工單 + 專屬顧問
SLA 保證99.9% uptime
更新頻率社群版本提前取得新功能

對大多數個人開發者和小型團隊來說,開源版已經足夠。需要團隊協作和 SLA 保證時,再考慮商業版。

插圖 1:GitHub Repository 頁面畫面

開發環境建置

本地開發環境設定

要在本地跑起 Clawbot 的原始碼,你需要準備以下工具:

必要工具:

工具版本要求用途
Node.js18.x 以上執行環境
pnpm8.x 以上套件管理
Git2.x 以上版本控制
Chrome最新穩定版Browser Relay 測試
Docker(選用)20.x 以上容器化執行

建置步驟:

# 1. Clone repo
git clone https://github.com/clawbot/core.git
cd core

# 2. 安裝依賴
pnpm install

# 3. 複製環境變數範本
cp .env.example .env

# 4. 編輯 .env,填入必要設定
# CLAWBOT_API_KEY=your_key
# BROWSER_PATH=/path/to/chrome

# 5. 啟動開發伺服器
pnpm dev

啟動成功後,預設會在 http://localhost:3000 開啟 API 伺服器,http://localhost:3001 開啟 Dashboard。

開發環境建置前,建議先完成 基本安裝,確認 Clawbot 在你的系統上能正常運作。

從原始碼編譯

如果你要建立自訂的 Production 版本:

# 編譯所有模組
pnpm build

# 只編譯特定模組
pnpm build --filter=@clawbot/core
pnpm build --filter=@clawbot/browser-relay

# 執行測試
pnpm test

# 執行 lint 檢查
pnpm lint

常見編譯問題:

  • 記憶體不足:編譯時 Node.js 預設記憶體可能不夠,加上 NODE_OPTIONS=--max-old-space-size=4096
  • TypeScript 版本衝突:確認使用 Repo 中指定的 TypeScript 版本,不要用全域安裝的
  • Chrome 路徑找不到:在 .env 中明確指定 Chrome 的執行檔路徑

開發者工具與 CLI

Clawbot CLI 是開發者最常用的工具,讓你在終端機中直接操作 Clawbot。

安裝 CLI:

npm install -g @clawbot/cli

常用指令:

# 初始化新專案
clawbot init my-automation

# 執行任務
clawbot run task.json

# 執行單次瀏覽器操作
clawbot exec "go to https://example.com and screenshot"

# 查看任務狀態
clawbot status

# 開啟 Debug 模式(顯示瀏覽器視窗)
clawbot run task.json --headed

# 執行測試
clawbot test task.json

Debug 模式特別實用:加上 --headed 參數,Browser Relay 會顯示瀏覽器視窗,讓你即時看到 AI Agent 正在做什麼。

想把 Clawbot 整合到現有系統架構中?預約免費架構諮詢,讓專家幫你規劃整合方案。

API 文件與整合開發

REST API 總覽

Clawbot API 遵循 RESTful 設計,所有回應為 JSON 格式。

項目說明
Base URLhttps://api.clawbot.io/v1
版本控制URL 路徑(/v1/v2
回應格式JSON
速率限制免費版 60 req/min,商業版 600 req/min

API 分類:

  • Tasks API:建立、查詢、更新、刪除自動化任務
  • Browser Relay API:控制瀏覽器實例,執行操作
  • Dashboard API:讀取統計資料、執行紀錄
  • Webhook API:設定和管理 Webhook 回呼

認證與權限管理

所有 API 請求都需要在 Header 中帶入 API Key:

Authorization: Bearer YOUR_API_KEY

API Key 安全性最佳實務:

  • 每個應用或服務使用獨立的 API Key
  • 設定最小權限範圍(例如某個 Key 只能讀取,不能建立任務)
  • 不要把 API Key 寫死在程式碼中,使用環境變數
  • 定期輪換 Key(建議每 90 天)
  • 在 Dashboard 中監控 Key 的使用紀錄

常用 API 端點範例

範例 1:建立任務(cURL)

curl -X POST https://api.clawbot.io/v1/tasks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Daily Price Check",
    "type": "browser_relay",
    "target_url": "https://example.com/products",
    "actions": [
      {"type": "waitForSelector", "selector": ".price-list"},
      {"type": "extract", "selector": ".product-item", "fields": {
        "name": ".product-name",
        "price": ".product-price"
      }}
    ],
    "schedule": "0 9 * * *"
  }'

範例 2:查詢任務狀態(Python)

import requests

API_KEY = "YOUR_API_KEY"
TASK_ID = "task_abc123"

response = requests.get(
    f"https://api.clawbot.io/v1/tasks/{TASK_ID}",
    headers={"Authorization": f"Bearer {API_KEY}"}
)

task = response.json()
print(f"Status: {task['status']}")
print(f"Last run: {task['last_run_at']}")
print(f"Results: {task['results']}")

範例 3:觸發 Browser Relay 操作(Node.js)

const axios = require('axios');

const API_KEY = process.env.CLAWBOT_API_KEY;

async function takeScreenshot(url) {
  const response = await axios.post(
    'https://api.clawbot.io/v1/browser/screenshot',
    {
      url: url,
      viewport: { width: 1920, height: 1080 },
      fullPage: true
    },
    {
      headers: { 'Authorization': `Bearer ${API_KEY}` }
    }
  );

  console.log('Screenshot URL:', response.data.screenshot_url);
  return response.data;
}

takeScreenshot('https://example.com');

範例 4:設定 Webhook(cURL)

curl -X POST https://api.clawbot.io/v1/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhook/clawbot",
    "events": ["task.completed", "task.failed"],
    "secret": "your_webhook_secret"
  }'

插圖 2:開發者在 VS Code 中撰寫 API 整合程式碼


需要企業級的 API 整合架構?

從單一 API 串接到多系統自動化流程,架構設計決定了系統的穩定性與擴展性。

CloudInsight 如何幫助你?

  • API 整合架構設計:Clawbot API 與企業現有系統的串接規劃
  • 微服務架構諮詢:將自動化流程拆分為可維護的微服務
  • 監控與告警設計:確保自動化流程 24/7 穩定運行

預約免費架構設計諮詢


社群與貢獻指南

如何回報 Bug

發現 Bug?到 GitHub Issues 回報。為了讓維護者快速理解問題,請使用 Issue Template:

Bug Report 必填欄位:

  1. 環境資訊:作業系統、Node.js 版本、Clawbot 版本
  2. 重現步驟:一步步描述如何觸發這個 Bug
  3. 預期行為:你期望發生什麼
  4. 實際行為:實際發生了什麼
  5. 錯誤訊息:完整的 error log 或截圖
  6. 相關程式碼:最小可重現範例(Minimal Reproducible Example)

寫得越清楚,修復速度越快。

如何提交 Pull Request

想貢獻程式碼?歡迎!流程如下:

1. Fork 官方 Repo
2. 建立功能分支:git checkout -b feature/my-feature
3. 撰寫程式碼和測試
4. 確保所有測試通過:pnpm test
5. 確保 lint 通過:pnpm lint
6. 提交 PR,填寫 PR Template
7. 等待 Code Review
8. 根據 Review 意見修改
9. Merge!

PR 注意事項:

  • 每個 PR 只做一件事,避免混合多個功能修改
  • 新功能必須附帶測試
  • 遵循現有的程式碼風格(ESLint + Prettier 設定已包含在 Repo 中)
  • 更新相關文件

社群討論頻道

頻道用途連結
GitHub Discussions技術討論、功能建議github.com/clawbot/core/discussions
Discord即時交流、問題求助discord.gg/clawbot
GitHub IssuesBug 回報、功能請求github.com/clawbot/core/issues

Discord 上有官方開發者和活躍的社群成員,通常在幾小時內就能得到回覆。

插圖 3:開發者在 Discord 社群交流

Clawbot 開發者常見問題

Clawbot 的 GitHub 在哪裡?

Clawbot 的 GitHub 組織頁面是 github.com/clawbot,底下有多個 Repo。

注意:你可能會搜到舊的 openclawmoltbot 相關 Repo。部分舊 Repo 已經 Archive,README 中會標示「已遷移至 clawbot」並提供新 Repo 連結。建議直接到 github.com/clawbot 找最新的程式碼。

可以商用嗎?

可以。開源版本採用 Apache 2.0 授權,明確允許商業使用。

但要注意:

  • 使用開源版本時,需保留原始的授權聲明和版權資訊
  • 商業版獨有的功能(企業 Dashboard、優先支援)需要另外購買授權
  • 如果你修改了原始碼並對外發布,需要標示修改內容

如何從 MoltBot / OpenClaw 的舊 Repo 遷移?

如果你之前 Fork 了 MoltBot 或 OpenClaw 的 Repo,遷移步驟:

# 1. 加入新的 remote
git remote add clawbot https://github.com/clawbot/core.git

# 2. Fetch 新的 Repo
git fetch clawbot

# 3. 建立新分支,基於最新的 Clawbot main
git checkout -b migration clawbot/main

# 4. Cherry-pick 你的自訂修改
git cherry-pick <your-commit-hash>

# 5. 解決衝突、測試、提交

主要的 Breaking Changes:

  • 套件名稱從 @openclaw/* 改為 @clawbot/*
  • 部分 API 端點路徑有變更(/v0/v1
  • 環境變數前綴從 OPENCLAW_ 改為 CLAWBOT_

詳細的遷移指南在 github.com/clawbot/core/blob/main/MIGRATION.md

想了解實際應用?請見 Clawbot AI Agent 自動化教學,學習如何用 Browser Relay 和 N8N 建立自動化流程。

插圖 4:終端機執行 Git 遷移指令

加入 Clawbot 開發者社群

Clawbot 作為開源專案,社群是它持續進化的動力。不論你是回報 Bug、提交 PR、還是在 Discord 上回答新手問題,每一份貢獻都有價值。

延伸閱讀


免費諮詢:Clawbot 企業整合與架構設計

如果你正在:

  • 將 Clawbot 整合到企業系統中
  • 設計自動化微服務架構
  • 需要 API 串接與部署建議

預約免費諮詢,我們會在 24 小時內回覆你。所有諮詢內容完全保密,沒有任何銷售壓力。


參考資料

  1. Clawbot GitHub,「Core Repository README」(2026)
  2. Clawbot 官方文件,「REST API Reference v1」(2026)
  3. Apache Software Foundation,「Apache License 2.0」
  4. GitHub Docs,「Contributing to projects」(2025)
  5. Node.js 官方文件,「Getting Started Guide」(2026)

需要專業的雲端建議?

無論您正在評估雲平台、優化現有架構,或尋找節費方案,我們都能提供協助

預約免費諮詢

相關文章