Quick installation guide for Linux, macOS, and Windows (WSL2)

Install Zirkabot

One command to install Zirkabot on any supported platform.

Quick Install

Linux / macOS / WSL2

curl -fsSL https://zirkabot.com/install.sh | bash

Windows (PowerShell)

irm https://zirkabot.com/install.ps1 | iex

Note: Native Windows requires WSL2. The PowerShell script will guide you through WSL2 setup if needed.

What the installer does

  1. Checks prerequisites — Git, Node.js 22+
  2. Clones the repository — to ~/.zirkabot/app
  3. Installs dependencies — via npm
  4. Creates the zirkabot command — in ~/.local/bin
  5. Runs onboarding — sets up daemon (systemd/launchd)

Requirements

Install Node.js (if needed)

# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash

# Install Node 22
nvm install 22

After Installation

# Start the gateway
zirkabot gateway

# Open the dashboard
open http://127.0.0.1:18789

# Or run the setup wizard
zirkabot onboard

Upgrade

curl -fsSL https://zirkabot.com/install.sh | bash -s -- --upgrade

Manual Installation

If you prefer manual installation:

# Clone
git clone https://github.com/PavloPe/zirkabot.git ~/.zirkabot/app

# Install
cd ~/.zirkabot/app
npm install

# Link binary
mkdir -p ~/.local/bin
cat > ~/.local/bin/zirkabot << 'WRAPPER'
#!/usr/bin/env bash
exec node ~/.zirkabot/app/dist/entry.js "$@"
WRAPPER
chmod +x ~/.local/bin/zirkabot

# Add to PATH (if needed)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# Verify
zirkabot --version

Uninstall

# Remove installation
rm -rf ~/.zirkabot
rm ~/.local/bin/zirkabot

# Remove systemd service (Linux)
systemctl --user disable zirkabot
rm ~/.config/systemd/user/zirkabot.service

Troubleshooting

"command not found: zirkabot"

Add ~/.local/bin to your PATH:

export PATH="$HOME/.local/bin:$PATH"

Node.js version too old

nvm install 22
nvm use 22

Permission denied

Don't run the installer with sudo. It installs to your home directory.


Getting Started →