Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/acp_gemini.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,4 +223,4 @@ $ACPX --agent "gemini --experimental-acp" sessions new --name my-gemini-tg

- [OpenClaw × ACP × Kiro 整合指南](./acp_kiro.md)
- [OpenClaw × ACP × Codex 整合指南](./acp_codex.md)
- [ACPX Harness 架構與演進史](../acpx-harness.md)
- [ACPX Harness 架構與演進史](./acpx-harness.md)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

看到這段新增內容,想確認:此欄位/描述是否已在 repo 的文件規範(schema/README)中定義?若是 frontmatter schema 的一部分,建議補上來源或連結,避免後續各文件自行發散。

39 changes: 38 additions & 1 deletion docs/acp_kiro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

【審查意見】變更內容需補充可驗證的依據/範例

  • 我需要可驗證的條件:此敘述是否對應到實際版本/行為?若是,請補上引用(指令輸出、版本範圍、或連結)。
  • 若是經驗法則,建議標註適用前提與例外情境,避免讀者照做踩雷。
  • 參考變更:---

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

看到這段新增內容,想確認:此欄位/描述是否已在 repo 的文件規範(schema/README)中定義?若是 frontmatter schema 的一部分,建議補上來源或連結,避免後續各文件自行發散。

last_validated: 2026-04-05
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

【審查意見】變更內容需補充可驗證的依據/範例

  • 我需要可驗證的條件:此敘述是否對應到實際版本/行為?若是,請補上引用(指令輸出、版本範圍、或連結)。
  • 若是經驗法則,建議標註適用前提與例外情境,避免讀者照做踩雷。
  • 參考變更:last_validated: 2026-04-05

validated_by: thepagent
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

【審查意見】變更內容需補充可驗證的依據/範例

  • 我需要可驗證的條件:此敘述是否對應到實際版本/行為?若是,請補上引用(指令輸出、版本範圍、或連結)。
  • 若是經驗法則,建議標註適用前提與例外情境,避免讀者照做踩雷。
  • 參考變更:validated_by: thepagent

---

# OpenClaw × ACP × Kiro 整合指南

讓你的 OpenClaw 透過 ACP 轉接 Kiro,實現對話持久化。
Expand Down Expand Up @@ -248,4 +253,36 @@ openclaw hooks list # 確認 ✓ ready

- [OpenClaw × ACP × Codex 整合指南](./acp_codex.md)
- [OpenClaw × ACP × Gemini 整合指南](./acp_gemini.md)
- [ACPX Harness 架構與演進史](../acpx-harness.md)
- [ACPX Harness 架構與演進史](./acpx-harness.md)

---

## 補充:`openclaw acp` vs ACP Agents(ACPX Harness)

本指南描述的是 **ACP Agents** 路線(OpenClaw → 啟動 Kiro CLI 執行任務)。

另一個容易混淆的概念是 `openclaw acp`,方向相反:

| | `openclaw acp` | 本指南(ACP Agents) |
|---|---|---|
| 方向 | IDE → OpenClaw | OpenClaw → Kiro CLI |
| 用途 | IDE 透過 ACP 連接 Gateway | OpenClaw 委派任務給 Kiro |
| 工具 | 無(純 bridge) | Kiro 原生工具(file edit、bash 等) |

## 補充:CLI Backends(text-only fallback)

若只需要 text-only 的安全網(API 掛掉時的 fallback),不需要完整 ACP harness,可用 CLI backends:

```json5
{
agents: {
defaults: {
cliBackends: {
"kiro-cli": { command: "/opt/homebrew/bin/kiro-cli" }
}
}
}
}
```

CLI backends 停用所有工具,僅做 text in → text out,適合作為 provider 故障時的降級方案。詳見 [ACPX Harness](./acpx-harness.md#cli-backends)。
46 changes: 46 additions & 0 deletions docs/acpx-harness.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

看到這段新增內容,想確認:此欄位/描述是否已在 repo 的文件規範(schema/README)中定義?若是 frontmatter schema 的一部分,建議補上來源或連結,避免後續各文件自行發散。

last_validated: 2026-04-05
validated_by: thepagent
---

# ACPX Harness

## ACPX Harness 是什麼
Expand All @@ -6,6 +11,47 @@ ACPX(ACP eXternal)Harness 是 OpenClaw ACP(Agent Communication Protocol)

---

## `openclaw acp` vs ACPX Harness(ACP Agents)

OpenClaw 有兩個容易混淆的 ACP 概念:

| | `openclaw acp` | ACPX Harness(ACP Agents) |
|---|---|---|
| 方向 | 外部 IDE/client → OpenClaw | OpenClaw → 外部 CLI |
| 用途 | IDE 透過 ACP 連接 OpenClaw Gateway | OpenClaw 啟動 Codex/Claude/Gemini 執行任務 |
| 指令 | `openclaw acp` | `/acp spawn`、binding `type: "acp"` |
| 工具 | 無(純 bridge) | 外部 CLI 原生工具 |

簡單記法:
- **editor 想連 OpenClaw** → `openclaw acp`
- **OpenClaw 想用外部 CLI** → ACPX Harness

## CLI Backends(text-only fallback)

OpenClaw 也支援 **CLI backends** 作為 API provider 掛掉時的 text-only 安全網:

```json5
{
agents: {
defaults: {
cliBackends: {
"claude-cli": { command: "/opt/homebrew/bin/claude" },
"codex-cli": { command: "/opt/homebrew/bin/codex" },
}
}
}
}
```

- 工具完全停用(text in → text out)
- 支援 session 和圖片傳遞
- 不需要額外 API key(用 CLI 自身的認證)
- 設計為安全網,非主要路徑

> CLI backends ≠ ACP。若需要完整的 harness runtime(工具呼叫、thread binding、persistent session),用 ACPX Harness。

---

## 它解決了什麼痛點

### 問題背景
Expand Down
33 changes: 33 additions & 0 deletions docs/binding_telegram.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,38 @@
---
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

看到這段新增內容,想確認:此欄位/描述是否已在 repo 的文件規範(schema/README)中定義?若是 frontmatter schema 的一部分,建議補上來源或連結,避免後續各文件自行發散。

last_validated: 2026-04-05
validated_by: thepagent
---

# Telegram Binding 指南

## DM 存取政策(dmPolicy)

`channels.telegram.dmPolicy` 控制私訊存取模式(`2026.2.25+`):

| dmPolicy | 說明 |
|----------|------|
| `pairing`(預設) | 新使用者需透過 pairing code 配對後才能 DM |
| `allowlist` | 僅允許 `allowFrom` 中列出的 numeric Telegram user ID |
| `open` | 任何人都可以 DM(需 `allowFrom: ["*"]`) |
| `disabled` | 完全關閉 DM |

```json5
{
channels: {
telegram: {
dmPolicy: "pairing",
allowFrom: [], // numeric Telegram user IDs
}
}
}
```

> ⚠️ **安全邊界(`2026.2.25+`)**:DM pairing 授權不會繼承到群組。Pairing 僅授予 DM 存取權。群組授權需透過 `groupAllowFrom` 或 per-group `allowFrom` 明確設定。
>
> 若希望「配對一次就能同時使用 DM 和群組」,請將你的 numeric Telegram user ID 加入 `channels.telegram.allowFrom`。

---

openclaw 的 `bindings` 設定支援兩種 Telegram 綁定模式:

| 模式 | 說明 | `match` 欄位 |
Expand Down
84 changes: 65 additions & 19 deletions docs/cli.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
last_validated: 2026-04-05
validated_by: thepagent
---

# CLI Quick Reference(指令速查)

> 目標:把最常用的 OpenClaw 指令整理成「抄得到就能用」的速查表。
Expand Down Expand Up @@ -33,58 +38,99 @@ openclaw onboard --install-daemon

---

## 3) Sessions / Subagents
## 3) Sessions / Agents

(以下命令視你的版本可能略有差異;以實際 help 為準)
```bash
openclaw sessions list
openclaw sessions history <sessionKey>
openclaw agent --message "hi"
openclaw agents list
```

- 列出 sessions
- 查某個 session 歷史
- 對某個 session 發訊息
---

> 在 chat 介面中,多數情境你會直接用 agent 的內建工具 `sessions_list / sessions_history / sessions_send`。
## 4) ACP / MCP

---
```bash
openclaw acp # 啟動 ACP bridge(IDE 連 OpenClaw)
openclaw mcp serve # 啟動 MCP server(外部 MCP client 連 OpenClaw)
```

## 4) Cron(排程)
> `openclaw acp` 是 Gateway-backed ACP bridge,不是 ACP harness。
> 若要讓 OpenClaw 啟動外部 CLI(Codex/Claude/Gemini),用 ACP Agents(`/acp spawn`)。

> 你也可以直接在 chat 用 `cron` tool 建立/管理。
---

概念:
- list:看有哪些 job
- add:新增 job
- run:立即觸發
- runs:看執行紀錄
## 5) Cron / Flows / Tasks

```bash
openclaw cron list
openclaw cron add
openclaw cron run <jobId>
openclaw cron runs
openclaw flows list # ClawFlow 工作流
openclaw tasks list # 任務管理
```

---

## 5) Nodes
## 6) Nodes / Devices

```bash
openclaw nodes status
openclaw nodes describe --node <id>
openclaw devices list
openclaw devices approve <requestId>
```

(配對流程與能力請看 `docs/nodes.md`)

---

## 6) 常用除錯
## 7) 管理工具

```bash
openclaw doctor # 診斷 + 修復
openclaw dashboard # Web dashboard
openclaw backup # 備份設定
openclaw models list # 模型清單
openclaw memory search <query> # 記憶搜尋
openclaw plugins list # 插件管理
openclaw secrets list # Secrets 管理
openclaw skills list # Skills 管理
openclaw pairing list # 配對管理
openclaw channels list # Channel 管理
openclaw approvals list # 審批管理
openclaw sandbox status # Sandbox 狀態
openclaw browser # 瀏覽器工具
openclaw hooks list # Hook 管理
openclaw webhooks list # Webhook 管理
openclaw logs # 查看日誌
openclaw system info # 系統資訊
```

---

## 8) 常用除錯

```bash
openclaw status
openclaw health
openclaw gateway status
openclaw doctor --fix
```

---

## 7) 常見工作流(例)
## 9) 常見工作流(例)

### 7.1 「我想確認 bot 還活著」
### 9.1 「我想確認 bot 還活著」

```bash
openclaw gateway status
```

### 7.2 「我想重啟所有東西」
### 9.2 「我想重啟所有東西」

```bash
openclaw gateway restart
Expand Down
17 changes: 12 additions & 5 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
last_validated: 2026-04-05
validated_by: thepagent
---

# Install(安裝)

> 目標:用最少步驟把 OpenClaw 安裝好,並避免常見的 PATH / 權限 / Node 版本坑。
Expand All @@ -9,8 +14,8 @@
## TL;DR

```bash
# 1) 安裝 Node.js(建議用 nvm 或 Volta 管)
node -v
# 1) 安裝 Node.js 24(建議用 nvm 或 Volta 管)
node -v # 需 v22.14+ 或 v24+
npm -v

# 2) 安裝 OpenClaw CLI
Expand All @@ -27,10 +32,12 @@ openclaw gateway status

## 1) 先決條件

- Node.js LTS(建議 >= 20
- **Node.js 22.14+**(必要),**Node 24 推薦**(安裝腳本、CI、release workflow 的預設版本
- npm
- 可連外下載套件(公司網路可能要 proxy)

> ⚠️ Node 20 已不再支援。若 `node -v` 顯示 v20 或更舊,請先升級。

### 建議:不要用系統自帶 node

系統自帶 node 常常太舊,或權限/路徑容易混亂。
Expand All @@ -53,8 +60,8 @@ brew install node

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
nvm install --lts
nvm use --lts
nvm install 24
nvm use 24
```

### 2.2 安裝 OpenClaw
Expand Down
5 changes: 5 additions & 0 deletions docs/linux_systemd.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
last_validated: 2026-04-05
validated_by: thepagent
---

# Linux(systemd)上的 OpenClaw Gateway:重啟、Port 衝突與 Model 設定踩坑

## TL;DR
Expand Down
5 changes: 5 additions & 0 deletions docs/nodes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
last_validated: 2026-04-05
validated_by: thepagent
---

# OpenClaw Nodes 深度解析

## 概述
Expand Down
5 changes: 5 additions & 0 deletions docs/openclaw-auto-update.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
last_validated: 2026-04-05
validated_by: thepagent
---

# OpenClaw 自動更新流程

使用 openclaw cron、Telegram 與 kiro-cli 實現自動版本檢查與更新。
Expand Down
5 changes: 5 additions & 0 deletions docs/pricing_howto.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
last_validated: 2026-04-05
validated_by: thepagent
---

# How to Configure Model Pricing in OpenClaw

OpenClaw doesn't include a built-in pricing database. Instead, you configure costs in your config file to match your actual provider expenses.
Expand Down
Loading