KuroryuuKuroryuu

Getting Started

Install and configure Kuroryuu in under 5 minutes.

Prerequisites

For Windows (native installation):

  • Python 3.12 — Download (required for MCP Core — uses FastAPI features not in older versions)
  • Node.js 18+ — Download (for Desktop and Web apps)
  • Git — Download
  • Windows 10/11 — PowerShell scripts and Win32 APIs for desktop automation

For Docker (cross-platform):

  • Docker with Docker Compose
  • Works on Windows, Linux, macOS

Quick Start (Windows)

# 1. Clone the repository
git clone https://github.com/ahostbr/kuroryuu-public.git
cd kuroryuu-public

# 2. Run the setup script
.\setup-project.ps1

# 3. Restart your terminal (picks up env variable)

# 4. Start all services
.\run_all.ps1

The setup script automatically handles everything — Python venv, Node dependencies, config generation, build assets, Electron builds, and FFmpeg download. See the Installation guide for what each step does.

Quick Start (Docker)

# 1. Clone and configure
git clone https://github.com/ahostbr/kuroryuu-public.git
cd kuroryuu-public
cp .env.example .env
# Edit .env and set ANTHROPIC_API_KEY

# 2. Start all services
docker-compose up -d

# 3. Verify
docker-compose ps

Access Points

| Service | URL | Purpose | |---------|-----|---------| | Desktop App | Launches automatically | Full Kuroryuu interface | | Gateway API | http://127.0.0.1:8200/docs | FastAPI + WebSocket | | MCP Core | http://127.0.0.1:8100/mcp | 15 tools, 107 actions | | Web UI | http://localhost:3000 | Browser interface (Docker) |

Next Steps