Getting Started

Prerequisites

• Node.js >= 18
• A Coding Agent CLI installed:
  • Cursor (agent CLI)
  • Claude Code (claude CLI)
  • OpenCode (opencode CLI)

Install

npm install -g golembot

Or with pnpm / yarn:

pnpm add -g golembot
# or
yarn global add golembot

Quick Start

Option A: Guided Setup (Recommended)

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

The onboard wizard walks you through engine selection, naming, IM channel setup, and scenario template selection in 7 interactive steps.

Option B: Manual Init

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

This creates:

• golem.yaml — assistant configuration
• skills/ — skill directory with built-in skills (general + im-adapter)
• AGENTS.md — auto-generated context for the Coding Agent
• .golem/ — internal state directory (gitignored)

Start a Conversation

golembot run

This opens an interactive REPL. Type your message and press Enter. The Coding Agent handles everything — reading files, running scripts, multi-step reasoning.

REPL commands:

• /help — show available commands
• /reset — clear the current session
• /quit or /exit — exit

Start the Gateway Service

golembot gateway

This starts both an HTTP API and any configured IM channel adapters. See Channels for IM setup.

Use as a Library

GolemBot's core is an importable TypeScript library:

import { createAssistant } from 'golembot';

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

for await (const event of assistant.chat('Analyze the sales data')) {
  if (event.type === 'text') process.stdout.write(event.content);
}

This pattern works for embedding into Slack bots, internal tools, SaaS products, or any Node.js application. See the Embed in Your Product guide for Express, Next.js, background job, and Slack examples.

What's Next

• Embed in Your Product — library integration patterns (Express, Next.js, queues)
• Configuration — understand golem.yaml and ${ENV_VAR} placeholders
• CLI Commands — full command reference
• Engines — compare Cursor, Claude Code, and OpenCode
• Skills — extend your assistant's capabilities