Quickstart

Install with the installer script

The fastest way to get Claworc running. The script auto-detects your environment, asks a few questions, and handles everything else.

Linux / macOS

curl -fsSL https://raw.githubusercontent.com/gluk-w/claworc/main/install.sh | bash

Or clone the repo and run it locally:

git clone https://github.com/gluk-w/claworc.git
cd claworc
bash install.sh

Windows

Open PowerShell (not Command Prompt) and run:

git clone https://github.com/gluk-w/claworc.git
cd claworc
.\install.ps1

If you see an execution policy error:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

The installer prompts you to choose Docker or Kubernetes deployment, then configures ports, the data directory, and pulls the necessary images automatically.

Tip

To upgrade an existing installation, run install.sh again — it detects the current deployment and offers to upgrade in place.

---

Create an admin account

Open http://localhost:8000 (or the URL shown by the installer). On first run, you’ll see a Create admin account form. Enter a username and password, then click Create account.

---

Create your first instance

1. Click New instance

   On the dashboard, click New instance.

2. Fill in the form

   Enter a display name (e.g., my-agent). Optionally set CPU and memory limits and add your API key.

3. Click Create

   Claworc provisions the container and establishes an SSH connection automatically. The instance appears in the dashboard with a yellow indicator while connecting.

4. Wait for Connected

   Once the SSH indicator turns green, the instance is fully ready.

---

Access your instance

With a connected instance, click any of these buttons from the dashboard:

Button	What it opens
Chrome	The agent’s browser (Chrome, Chromium, or Brave depending on your image)
Terminal	A full interactive terminal via VNC
Logs	Live streaming container output

---

Connection states

Each instance shows a real-time SSH connection indicator:

Indicator	State	Meaning
Green	Connected	SSH tunnel is active and healthy
Yellow	Connecting / Reconnecting	Establishing or re-establishing connection
Gray	Disconnected	Not yet connected or manually stopped
Red	Failed	Connection failed after all retries

Note

Claworc automatically reconnects if a connection drops, including after container restarts.

---

Uninstall

bash uninstall.sh

---

Next steps

Manual installation Set up Claworc manually with Docker Compose or Helm without the installer script.

Managing instances Learn all the ways to manage your agent instances.

Authentication Set up users, roles, and passkeys.

Environment variables Configure Claworc with environment variables.