Skip to content

README.zh.md

Latest commit

 

History

History
132 lines (92 loc) · 4.22 KB

README.zh.md

File metadata and controls

132 lines (92 loc) · 4.22 KB

LarkCoder

English | 中文

通过飞书 IM 消息控制 ACP 兼容的 Coding Agent（Claude Code、Codex、OpenCode 等），在远程服务器上完成编码工作。

功能

  • 飞书对话驱动 — 在飞书聊天中直接向 ACP 兼容的 Coding Agent 发送编码指令，支持私聊和群组
  • Shell 命令执行 — 使用 ! 前缀在会话工作目录中执行 shell 命令，支持实时流式输出
  • 流式输出 — 通过飞书交互式卡片实时展示 Agent 的输出内容和工具调用过程
  • 多会话管理 — 每个对话/话题独立维护会话，支持创建、恢复、切换和删除
  • 项目管理 — 支持创建、切换、编辑项目，每个项目拥有独立的工作目录和会话空间
  • 权限确认 — Agent 执行敏感操作时弹出确认卡片，由用户选择是否允许
  • 模型切换 — 在飞书中随时切换 Claude 模型

前置条件

  • Bun 运行时
  • ACP 兼容的 Coding Agent（可在 ACP Registry 查看可用的 Agent）
  • 飞书开放平台应用（需开启消息接收和卡片回调事件）

快速开始

方式一：使用 bunx（推荐）

直接通过 bunx 运行，无需克隆项目：

# 启动服务（首次运行时自动进入交互式配置向导）
bunx --bun larkcoder

# 或显式初始化配置文件
bunx --bun larkcoder --init

方式二：本地开发

# 克隆项目
git clone <repo-url> && cd larkcoder

# 安装依赖
bun install

# 启动服务（首次运行时自动进入交互式配置向导）
bun run start
# 或直接运行
bun bin/larkcoder.ts

# 或使用开发模式（直接运行 src/index.ts，使用环境变量 CONFIG_PATH）
bun run dev

本地调试提示：

  • 使用 bun run start 或 bun bin/larkcoder.ts 可以像 bunx --bun larkcoder 一样使用 CLI 功能（如 --init、--config、--log-level 等），但运行的是本地代码，方便调试和修改
  • 使用 bun run dev 直接运行 src/index.ts，适合快速启动（使用默认 .larkcoder/config.yaml 或 CONFIG_PATH 环境变量）

配置

CLI 选项

bunx --bun larkcoder [选项]

选项:
  -c, --config <path>        指定配置文件路径 (默认: .larkcoder/config.yaml)
  -l, --log-level <level>    设置日志级别 (trace, debug, info, warn, error, fatal)
  -i, --init                 初始化或编辑配置文件（交互式向导）
      --setup, --settings    --init 的别名
  -h, --help                 显示帮助信息

环境变量:
  LOG_LEVEL    设置日志级别（会被 --log-level 参数覆盖）
  CONFIG_PATH  设置配置文件路径（会被 --config 参数覆盖）

配置文件

配置向导会在首次运行时自动创建 .larkcoder/config.yaml，也可以手动编辑：

lark:
  app_id: "cli_xxxxxx" # 飞书应用 App ID
  app_secret: "your_app_secret" # 飞书应用 App Secret
  stream_flush_interval: 150 # ms，流式输出节流间隔

agent:
  command: "npx @zed-industries/claude-code-acp" # ACP 命令（必填），支持追加参数
  working_dir: ".larkcoder/projects" # Agent 工作目录

database:
  path: ".larkcoder/data/larkcoder.db" # 数据库文件路径
  event_max_age: 86400 # 秒，事件最大保留时间（默认 1 天）

shell:
  timeout: 300000 # ms，shell 命令超时时间（默认 5 分钟）
  max_output: 100000 # bytes，最大输出大小（默认 100KB）

提示：可以使用其他 ACP 兼容的 Coding Agent，只需修改 agent.command 字段即可，例如 "my-acp-server --flag"。

Shell 配置：shell 配置项为可选，不配置时使用默认值。

使用

直接在飞书中发送消息即可与 Agent 对话。在群组中需要 @机器人。

命令列表

发送 /help 查看所有可用命令。常用命令：

  • /new [prompt] — 创建新会话
  • /stop — 停止 Agent
  • /kill — 终止 shell 命令
  • /model — 切换模型
  • /project — 项目管理

Shell 命令执行

使用 ! 前缀在会话的工作目录中执行 shell 命令：

! ls -la
! git status
! npm install

License

MIT