跳转到内容
CoderClaw CoderClaw

个人助手设置

使用 CoderClaw 构建个人助手

Section titled “使用 CoderClaw 构建个人助手”

CoderClaw 是 Pi 智能体的 WhatsApp + Telegram + Discord + iMessage Gateway 网关。插件可添加 Mattermost。本指南是”个人助手”设置：一个专用的 WhatsApp 号码，表现得像你的常驻智能体。

⚠️ 安全第一

Section titled “⚠️ 安全第一”

你正在让智能体处于可以：

  • 在你的机器上运行命令（取决于你的 Pi 工具设置）
  • 在你的工作区读/写文件
  • 通过 WhatsApp/Telegram/Discord/Mattermost（插件）发送消息

从保守开始：

  • 始终设置 channels.whatsapp.allowFrom（永远不要在你的个人 Mac 上对全世界开放）。
  • 为助手使用专用的 WhatsApp 号码。
  • 心跳现在默认每 30 分钟一次。在你信任设置之前，通过设置 agents.defaults.heartbeat.every: "0m" 来禁用。

先决条件

Section titled “先决条件”
  • Node 22+
  • CoderClaw 在 PATH 中可用（推荐：全局安装）
  • 助手的第二个手机号码（SIM/eSIM/预付费）
Terminal window
npm install -g coderclaw@latest
# 或：pnpm add -g coderclaw@latest

从源代码（开发）：

Terminal window
git clone https://github.com/SeanHogg/coderClaw.git
cd coderclaw
pnpm install
pnpm ui:build # 首次运行时自动安装 UI 依赖
pnpm build
pnpm link --global

双手机设置（推荐）

Section titled “双手机设置（推荐）”

你需要这样：

你的手机（个人）               第二部手机（助手）
┌─────────────────┐           ┌─────────────────┐
│  你的 WhatsApp  │  ──────▶  │   助手 WA       │
│  +1-555-YOU     │  消息     │  +1-555-ASSIST  │
└─────────────────┘           └────────┬────────┘
                                       │ 通过二维码关联
                                       ▼
                              ┌─────────────────┐
                              │  你的 Mac       │
                              │  (coderclaw)     │
                              │    Pi 智能体    │
                              └─────────────────┘

如果你将个人 WhatsApp 关联到 CoderClaw，发给你的每条消息都会变成”智能体输入”。这通常不是你想要的。

5 分钟快速开始

Section titled “5 分钟快速开始”
  1. 配对 WhatsApp Web（显示二维码；用助手手机扫描）：
Terminal window
coderclaw channels login
  1. 启动 Gateway 网关（保持运行）：
Terminal window
coderclaw gateway --port 18789
  1. 在 ~/.coderclaw/coderclaw.json 中放置最小配置：
{
  channels: { whatsapp: { allowFrom: ["+15555550123"] } },
}

现在从你允许列表中的手机向助手号码发消息。

新手引导完成后，我们会自动打开带有 Gateway 网关令牌的仪表板并打印带令牌的链接。稍后重新打开：coderclaw dashboard。

给智能体一个工作区（AGENTS）

Section titled “给智能体一个工作区（AGENTS）”

CoderClaw 从其工作区目录读取操作指令和”记忆”。

默认情况下，CoderClaw 使用 ~/.coderclaw/workspace 作为智能体工作区，并会在设置/首次智能体运行时自动创建它（加上起始的 AGENTS.md、SOUL.md、TOOLS.md、IDENTITY.md、USER.md）。BOOTSTRAP.md 仅在工作区是全新的时候创建（删除后不应再出现）。

提示：将此文件夹视为 CoderClaw 的”记忆”，并将其设为 git 仓库（最好是私有的），这样你的 AGENTS.md + 记忆文件就有了备份。如果安装了 git，全新的工作区会自动初始化。

Terminal window
coderclaw setup

完整工作区布局 + 备份指南：智能体工作区 记忆工作流：记忆

可选：使用 agents.defaults.workspace 选择不同的工作区（支持 ~）。

{
  agent: {
    workspace: "~/.coderclaw/workspace",
  },
}

如果你已经从仓库提供了自己的工作区文件，可以完全禁用引导文件创建：

{
  agent: {
    skipBootstrap: true,
  },
}

将其变成”助手”的配置

Section titled “将其变成”助手”的配置”

CoderClaw 默认为良好的助手设置，但你通常需要调整：

  • SOUL.md 中的人设/指令
  • 思考默认值（如果需要）
  • 心跳（一旦你信任它）

示例：

{
  logging: { level: "info" },
  agent: {
    model: "anthropic/claude-opus-4-5",
    workspace: "~/.coderclaw/workspace",
    thinkingDefault: "high",
    timeoutSeconds: 1800,
    // 从 0 开始；稍后启用。
    heartbeat: { every: "0m" },
  },
  channels: {
    whatsapp: {
      allowFrom: ["+15555550123"],
      groups: {
        "*": { requireMention: true },
      },
    },
  },
  routing: {
    groupChat: {
      mentionPatterns: ["@coderclaw", "coderclaw"],
    },
  },
  session: {
    scope: "per-sender",
    resetTriggers: ["/new", "/reset"],
    reset: {
      mode: "daily",
      atHour: 4,
      idleMinutes: 10080,
    },
  },
}

会话和记忆

Section titled “会话和记忆”
  • 会话文件：~/.coderclaw/agents/<agentId>/sessions/{{SessionId}}.jsonl
  • 会话元数据（token 使用量、最后路由等）：~/.coderclaw/agents/<agentId>/sessions/sessions.json（旧版：~/.coderclaw/sessions/sessions.json）
  • /new 或 /reset 为该聊天启动新会话（可通过 resetTriggers 配置）。如果单独发送，智能体会回复一个简短的问候来确认重置。
  • /compact [instructions] 压缩会话上下文并报告剩余的上下文预算。

心跳（主动模式）

Section titled “心跳（主动模式）”

默认情况下，CoderClaw 每 30 分钟运行一次心跳，提示词为： Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK. 设置 agents.defaults.heartbeat.every: "0m" 来禁用。

  • 如果 HEARTBEAT.md 存在但实际上是空的（只有空行和 markdown 标题如 # Heading），CoderClaw 会跳过心跳运行以节省 API 调用。
  • 如果文件不存在，心跳仍然运行，模型决定做什么。
  • 如果智能体回复 HEARTBEAT_OK（可选带有短填充；参见 agents.defaults.heartbeat.ackMaxChars），CoderClaw 会为该心跳抑制出站投递。
  • 心跳运行完整的智能体轮次 — 更短的间隔会消耗更多 token。
{
  agent: {
    heartbeat: { every: "30m" },
  },
}

媒体输入和输出

Section titled “媒体输入和输出”

入站附件（图片/音频/文档）可以通过模板暴露给你的命令：

  • {{MediaPath}}（本地临时文件路径）
  • {{MediaUrl}}（伪 URL）
  • {{Transcript}}（如果启用了音频转录）

来自智能体的出站附件：在单独一行包含 MEDIA:<path-or-url>（无空格）。示例：

这是截图。
MEDIA:https://example.com/screenshot.png

CoderClaw 会提取这些并将它们作为媒体与文本一起发送。

运维检查清单

Section titled “运维检查清单”
Terminal window
coderclaw status          # 本地状态（凭证、会话、排队事件）
coderclaw status --all    # 完整诊断（只读，可粘贴）
coderclaw status --deep   # 添加 Gateway 网关健康探测（Telegram + Discord）
coderclaw health --json   # Gateway 网关健康快照（WS）

日志位于 /tmp/coderclaw/（默认：coderclaw-YYYY-MM-DD.log）。

下一步

Section titled “下一步”