快速开始

前置条件

• Node.js >= 18
• 安装一个 Coding Agent CLI：
  • Cursor（agent CLI）
  • Claude Code（claude CLI）
  • OpenCode（opencode CLI）

安装

npm install -g golembot

或使用 pnpm / yarn：

pnpm add -g golembot
# 或
yarn global add golembot

快速上手

方式 A：引导式设置（推荐）

mkdir my-bot && cd my-bot
golembot onboard

引导向导会带你完成引擎选择、命名、IM 通道配置和场景模板选择，共 7 个交互步骤。

方式 B：手动初始化

mkdir my-bot && cd my-bot
golembot init -e claude-code -n my-bot

这会创建：

• golem.yaml — 助手配置文件
• skills/ — 技能目录，包含内置技能（general + im-adapter）
• AGENTS.md — 为 Coding Agent 自动生成的上下文文档
• .golem/ — 内部状态目录（gitignore）

开始对话

golembot run

这会打开交互式 REPL。输入消息按回车即可。Coding Agent 负责一切 — 读写文件、运行脚本、多步推理。

REPL 命令：

• /help — 显示可用命令
• /reset — 清除当前会话
• /quit 或 /exit — 退出

启动 Gateway 服务

golembot gateway

这会同时启动 HTTP API 和已配置的 IM 通道适配器。IM 配置详见通道。

作为库使用

GolemBot 的核心是一个可导入的 TypeScript 库：

import { createAssistant } from 'golembot';

const assistant = createAssistant({ dir: './my-bot' });

for await (const event of assistant.chat('分析销售数据')) {
  if (event.type === 'text') process.stdout.write(event.content);
}

这种模式适用于嵌入 Slack 机器人、内部工具、SaaS 产品或任何 Node.js 应用。Express、Next.js、后台任务等完整示例见嵌入到你的产品指南。

下一步

• 嵌入到你的产品 — 库集成模式（Express、Next.js、队列任务）
• 配置说明 — 了解 golem.yaml 和 ${ENV_VAR} 占位符
• CLI 命令 — 完整命令参考
• 引擎 — 对比 Cursor、Claude Code 和 OpenCode
• 技能 — 扩展助手能力