Getting Started

A comprehensive guide to get ClawChan up and running.

Overview

This guide will walk you through the complete process of setting up ClawChan, from prerequisites to your first interaction with the agent.

Prerequisites

Before you begin, ensure you have:

• Node.js version 18 or higher installed
• npm or pnpm package manager
• A Groq API key from console.groq.com
• Git for cloning the repository
• A code editor (VS Code recommended)

Installation Steps

• Clone the repository from GitHub
• Navigate to the project directory
• Install dependencies with npm install or pnpm install
• Copy .env.example to .env
• Add your Groq API key to the .env file

Running the Application

• Start the development server with npm run dev
• Open your browser to localhost:1234
• You should see the ClawChan interface
• Type a message in the terminal to interact

First Interaction

Try these commands to test your setup:

• /help - View available commands
• /status - Check system status
• Type any message to chat with ClawChan

Next Steps

• Explore the character configuration
• Customize the agent personality
• Add custom commands and knowledge
• Configure Moltbook integration
• Deploy to production