Mac / Windows / Linux Installation Guide
Choose your platform and follow the steps — up and running in under a minute.
macOS
Option 1: Desktop Installer (Recommended)
The easiest way to get started. No terminal needed.
- Download the macOS installer: openclacky-installer.dmg
- Open the
.dmgfile and drag OpenClacky into your Applications folder - Launch OpenClacky — the service starts automatically
- Click Open in Browser to access the Web UI
Supports both Apple Silicon (M1/M2/M3) and Intel chips.
Option 2: Command Line
For developers or power users. Open Terminal and run:
/bin/bash -c "$(curl -sSL https://raw.githubusercontent.com/clacky-ai/openclacky/main/scripts/install.sh)"
The script installs Ruby and OpenClacky automatically.
After installation, you have two ways to start:
1. WebUI mode (recommended for beginners)
Start the local server:
openclacky server
Then visit: http://127.0.0.1:7070 in your browser
2. CLI mode (command-line chat)
Chat directly in your terminal:
openclacky
Windows
System Requirements: Windows 10 version 2004 (build 19041) or later, or Windows 11
Option 1: Desktop Installer (Recommended)
One-click setup for all users.
- Download the Windows installer: openclacky-installer.exe
- Run the installer and follow the prompts
- Launch OpenClacky from the Start Menu or desktop shortcut
- Click Open in Browser to access the Web UI
If Windows shows an "Unknown Publisher" warning, click Run Anyway. The installer is not yet code-signed.
Option 2: Command Line (PowerShell)
For developers. Open PowerShell and run:
powershell -c "& ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/clacky-ai/openclacky/main/scripts/install.ps1')))"
After installation, you have two ways to start:
1. WebUI mode (recommended for beginners)
Start the local server:
openclacky server
Then visit: http://127.0.0.1:7070 in your browser
2. CLI mode (command-line chat)
Chat directly in your terminal:
openclacky
Linux
Linux does not have a desktop installer. Use the command line instead.
Command Line
Open a terminal and run:
/bin/bash -c "$(curl -sSL https://raw.githubusercontent.com/clacky-ai/openclacky/main/scripts/install.sh)"
The script installs Ruby and OpenClacky automatically.
After installation, you have two ways to start:
1. WebUI mode (recommended for beginners)
Start the local server:
openclacky server
Then visit: http://127.0.0.1:7070 in your browser
2. CLI mode (command-line chat)
Chat directly in your terminal:
openclacky
Tested on Ubuntu 20.04+, Debian 11+, and CentOS 8+.
After Installing: Configure Your AI Key
On first launch, you'll be guided to add an AI Key. OpenClacky supports the following providers:
- OpenClacky — Recommended. Hosted keys, no setup. Get one →
- Anthropic (Claude) — Best quality. Recommended: claude-sonnet-4-6
- OpenAI (GPT) — gpt-5.5
- Kimi (Moonshot) — kimi-k2.6
- DeepSeek V4 — deepseek-v4-pro
- Minimax — MiniMax-M3
- GLM (ZhipuAI) — GLM-5.1
- Qwen (Alibaba) — qwen3.7-max
- MiMo (Xiaomi) — mimo-v2.5-pro
- OpenRouter — One key for all major models
Go to Settings → AI Keys in the Web UI and enter your API Key to get started.
More models are being added continuously.
How to Uninstall
To completely remove OpenClacky, run the uninstall script:
/bin/bash -c "$(curl -sSL https://raw.githubusercontent.com/clacky-ai/openclacky/main/scripts/uninstall.sh)"
The uninstall script will:
- Remove the OpenClacky CLI and all dependencies
- Ask if you want to keep your config files (API Keys, Skills, etc.)
- Clean up temporary files from installation
Tip: Desktop installer users can also use this command. macOS users can also just drag the app to Trash.
If you run into any issues during installation, see Windows Installation Troubleshooting.