Getting Started

Welcome to SkimpyClaw! This guide will help you get up and running with your personal AI assistant.

What is SkimpyClaw?

SkimpyClaw is a lightweight (~21k LOC) personal AI assistant that runs locally on your machine. It provides:

• Multi-channel chat — Telegram and Discord bots with persistent conversation history
• Tool-enabled agent — File read/write, bash, fetch, MCP tools
• Agents — Multiple configured agent identities with their own prompts, models, effort, and memory
• Cron scheduler — Run prompts or scripts on a schedule
• Web dashboard — Manage everything through a beautiful web interface
• Coding agents — Delegate coding tasks to Claude Code or Codex workers

Quick Start

pnpm add -g skimpyclaw
skimpyclaw onboard
skimpyclaw start --daemon

Next Steps

• Read the Architecture overview
• Learn about Configuration
• Review Security controls and hardening notes
• Follow the Discord Update Documentation Process when changing Discord behavior
• Explore available Tools
• Configure Agents and optional Discord profile aliases
• Set up Cron jobs for scheduled and long-running tasks

Getting Help

• Check the Troubleshooting guide
• Browse the API Reference
• Open an issue on GitHub