Getting Started

Get ScalyClaw installed and running in under five minutes. This guide covers prerequisites, installation, and your first interaction.

Prerequisites

Dependency	Version	Purpose
Bun	latest	JavaScript runtime for all ScalyClaw processes
Redis	≥ 6.2	Message bus, config, vault, pub/sub
Git	any	Cloning the repository

Operating System Support

OS	Status
macOS (Apple Silicon / Intel)	Fully supported
Linux (x64 / arm64)	Fully supported
Windows (via WSL2)	Supported
Docker	Fully supported

Windows Users

Native Windows is not supported. Use WSL2 with a Linux distribution (Ubuntu recommended). Redis and Bun run natively inside WSL.

Installing Bun

bash

curl -fsSL https://bun.sh/install | bash

Installing Redis

bash

# macOS
brew install redis && brew services start redis

# Ubuntu / Debian
sudo apt install redis-server && sudo systemctl enable redis-server

# Docker
docker run -d --name redis -p 6379:6379 redis:6-alpine

Installation

Quick Install (recommended)

bash

curl -fsSL https://scalyclaw.com/install.sh | sh

This installs Bun, Redis, clones the repo, builds everything, seeds the default config in Redis, and starts all processes (node, 3 workers, dashboard). Everything lives under ~/.scalyclaw.

Manual Install (from source)

bash

# Clone the repo
git clone https://github.com/scalyclaw/scalyclaw.git
cd scalyclaw

# Install dependencies
bun install

# Build shared packages
bun run build

First Run

1. Run the Setup Wizard

bash

# From source — run the CLI setup
bun run scalyclaw:node setup

The wizard walks you through:

Redis connection (defaults to localhost:6379)
Adding your first LLM provider (OpenAI, Anthropic, etc.)
Configuring an embedding model for memory
Setting a dashboard password

2. Start the Processes

bash

# Start the node (brain)
bun run scalyclaw:node start

# Start a worker (execution engine)
bun run scalyclaw:worker setup --name worker1
bun run scalyclaw:worker start --name worker1

# Start the dashboard
bun run scalyclaw:dashboard start

Quick Install

If you used the one-line installer, everything is already running. Manage it with ~/.scalyclaw/scalyclaw.sh --stop, --start, --update, --status, or --uninstall.

3. Open the Dashboard

Navigate to http://localhost:4173 in your browser. From here you can:

Configure your first messaging channel (e.g., Telegram)
Add LLM models and set priorities
Customize the personality in the Mind page
Send a test message via the Web Gateway

4. Send Your First Message

The fastest way to test is via the Web Gateway. In the dashboard, go to Channels → Web, enable it, then use the built-in chat widget or make an API call:

bash

curl -X POST http://localhost:3000/api/message \
  -H "Content-Type: application/json" \
  -d '{"text": "Hello, ScalyClaw!"}'

Project Structure

scalyclaw/ ├── scalyclaw/ # Node — orchestrator, channels, guards, LLM │ └── src/ │ ├── channels/ # Telegram, Discord, Slack, etc. │ ├── orchestrator/ # Prompt building, LLM routing │ ├── guards/ # Echo, content, skill guards │ └── queue/ # BullMQ queue producers ├── worker/ # Worker — stateless BullMQ consumer (tools queue only) │ └── src/ # tool-processor, execute-skill, execute-code, execute-command ├── cli/ # CLI — setup wizards, process management ├── dashboard/ # Dashboard — React 19 SPA │ └── src/ │ ├── pages/ # admin pages │ └── components/ # Shared UI components ├── shared/ # Shared library — types, utils, prompt │ └── src/ │ ├── prompt/ # System prompt sections │ └── memory/ # SQLite + sqlite-vec memory system ├── mind/ # Personality files (user-editable) │ ├── IDENTITY.md # Who it is, tone, boundaries │ ├── SOUL.md # Core values and behavior │ └── USER.md # Baseline user profile ├── skills/ # Skill packages (each in its own folder) ├── agents/ # Agent definitions └── website/ # Landing page and docs