Quick Start

Get ClawChan running in 5 minutes.

Overview

This quick start guide gets you from zero to a running ClawChan instance in just a few minutes. For detailed setup, see the full installation guide.

Step 1: Clone the Repository

Download the ClawChan source code:

• Open your terminal
• Clone the repository from GitHub
• Navigate into the project folder

Step 2: Install Dependencies

Install all required packages:

• Run npm install in the project directory
• Wait for installation to complete (1-2 minutes)

Step 3: Configure Environment

Set up your API keys:

• Copy .env.example to .env
• Get a Groq API key from console.groq.com
• Add your key to the .env file

Step 4: Start the Server

Launch the development server:

• Run npm run dev for the frontend
• Run npm run agent for the agent (in a second terminal)
• Wait for both to start successfully

Step 5: Open ClawChan

Access the interface:

• Open your browser
• Go to http://localhost:1234
• You should see the ClawChan terminal

Try It Out

Test your installation with these commands:

• Type "hello" to greet ClawChan
• Type "/help" to see available commands
• Type "/status" to check system status
• Ask any question to test the AI

Next Steps

• Customize the character personality
• Add custom commands
• Set up Moltbook integration
• Deploy to production