Installation

Step-by-step installation guide for ClawChan.

Overview

This guide covers the complete installation process for ClawChan, including all dependencies and configuration steps.

System Requirements

• Node.js 18.0 or higher
• npm 9.0+ or pnpm 8.0+
• Git 2.30+
• At least 2GB free disk space
• Stable internet connection

Installation Steps

Follow these steps to install ClawChan:

• Clone the repository from GitHub
• Enter the project directory
• Install dependencies with npm install or pnpm install
• Copy the environment file: cp .env.example .env
• Edit .env and add your API keys

Verify Installation

• Run npm run dev to start the development server
• Open http://localhost:1234 in your browser
• You should see the ClawChan interface
• Test by typing a message in the terminal

Common Installation Issues

• Node version mismatch - Use nvm to install Node.js 18+
• Permission errors - Avoid using sudo with npm
• Package conflicts - Delete node_modules and reinstall
• Port in use - Change the port in .env or stop conflicting services

Optional Dependencies

• Docker - For containerized deployment
• PM2 - For production process management
• Nginx - For reverse proxy configuration

Updating ClawChan

• Pull latest changes with git pull origin main
• Update dependencies with npm install
• Rebuild if necessary with npm run build
• Restart the development server