Installation

CH-UI ships as a single binary for server and connector operations.

Quick Install (Recommended)

The installer script detects your OS and architecture, downloads the latest release, and places the binary in your PATH.

curl -fsSL https://ch-ui.com/install.sh | sh

This works on Linux (amd64, arm64) and macOS (Intel, Apple Silicon).

After installation, verify it works:

ch-ui version

Manual Download

If you prefer to download manually, grab the binary from GitHub Releases.

Available binaries:

• ch-ui-linux-amd64
• ch-ui-linux-arm64
• ch-ui-darwin-amd64
• ch-ui-darwin-arm64

curl -L -o ch-ui https://github.com/caioricciuti/ch-ui/releases/latest/download/ch-ui-linux-amd64
chmod +x ch-ui
./ch-ui version

Start Server

ch-ui server --port 3488

Open http://localhost:3488.

Local Connector Behavior

When the server starts, CH-UI can run an embedded connector against local ClickHouse (http://localhost:8123) so you can get started quickly.

Recommended First Steps

1. Login with a ClickHouse username/password.
2. Open Admin and verify users/connections.
3. Open Governance and run initial sync.
4. If Pro is enabled, configure Brain providers and Alert channels.

Next Steps