Quick Start

Get SeaClip running in 5 minutes

Prerequisites
  • Linux, macOS, or WSL2
  • Node.js 20+ and pnpm
  • Git

Step 1: Install the Hub

bash — One-line install
curl -sSL https://raw.githubusercontent.com/t4tarzan/seaclip/main/scripts/install.sh | bash

Or clone manually:

bash
git clone https://github.com/t4tarzan/seaclip.git
cd seaclip
pnpm install
pnpm dev

Step 2: Open the Dashboard

Navigate to:

url
http://localhost:5173

You should see the SeaClip dashboard with:

Step 3: Connect a Spoke (Optional)

On your edge device (Raspberry Pi, Jetson, etc.):

bash — Run on edge device
curl -sSL https://raw.githubusercontent.com/t4tarzan/seaclip/main/scripts/spoke-install.sh | bash -s -- --hub http://YOUR_HUB_IP:51842

Replace YOUR_HUB_IP with your hub server's IP address.

Step 4: Verify Connection

On the hub:

bash
pnpm cli device list

Your spoke should appear in the list with status online.

Step 5: Run Health Check

bash
pnpm cli doctor
$ pnpm cli doctor
✓ Node.js version: 20.11.0
✓ pnpm version: 8.15.0
✓ Database: connected
✓ Server: running on port 51842
✓ WebSocket: active
✓ Devices: 1 online

All checks passed!

What's Next?

Common Commands

Command Description
pnpm dev Start development server
pnpm build Build for production
pnpm cli doctor Health check
pnpm cli device list List connected devices
pnpm cli agent list List agents
pnpm cli onboard Interactive setup wizard