The operational advisor for ClickHouse
Live demo · Website · Docs · Getting started · Quick start
chmonitor is a dashboard and advisor for ClickHouse. It reads system.*
tables and shows what the cluster is doing — queries, merges, replication,
storage, health — then recommends what to change next.
It does not apply DDL for you. Recommendations stay recommendations.
Runs the same way on Docker, Kubernetes, bare metal, or ClickHouse Cloud. Self-host it free (GPL-3.0), or use the hosted demo.
Current release: v0.3.6. Upgrading from v0.2? See Migrate to v0.3.
| You need | chmonitor |
|---|---|
| See the cluster | Overview, topology, health checks, 30+ charts |
| Catch expensive work | Running, slow, failed, and historical queries |
| Understand data | Explorer, table size, parts, compression, TTLs |
| Keep replicas healthy | Merges, mutations, replication queue, Keeper |
| Get a second opinion | AI advisor: projections, skip indexes, PREWHERE, MVs |
| Ask in English | Built-in AI agent + MCP for Claude / Cursor |
| Work from a terminal | chm CLI — live TUI and chm doctor |
Works with multiple ClickHouse hosts from one dashboard (?host=0).
More detail: docs · AI agent · editions
One container, pointed at any reachable ClickHouse (OSS, Altinity, or ClickHouse Cloud):
docker run -d --name chmonitor -p 3000:3000 \
-e CLICKHOUSE_HOST=https://clickhouse.example.com:8443 \
-e CLICKHOUSE_USER=default \
-e CLICKHOUSE_PASSWORD=change-me \
ghcr.io/chmonitor/chmonitor:0.3.6Open http://localhost:3000. Pin a version tag in production; use :latest only if you want the rolling tip.
Image tags carry no v prefix — the release v0.3.6 publishes 0.3.6, plus
0.3 and latest.
Want a look first? dash.chmonitor.dev — no setup.
Install the CLI:
curl -sSf https://chmonitor.dev/install.sh | bash
chm doctorSame CLICKHOUSE_HOST / CLICKHOUSE_USER / CLICKHOUSE_PASSWORD everywhere.
| Target | Guide |
|---|---|
| Docker | docs/operate/deploy/docker |
| Kubernetes (Helm) | docs/operate/deploy/k8s |
| Cloudflare Workers | docs/operate/deploy |
| Railway / Render / Fly | One-click |
| Local development | Getting started |
Release artifacts (Docker image, Node standalone, Workers archive) are on the GitHub Releases page.
chmonitor is GPL-3.0: self-host every feature, unlimited hosts, no payment, no key. A commercial license is optional and buys paper, not features — an invoice and named vendor, priority email support for the paid term, and an opt-in listing. Same binary either way.
| License | Hosts | Yearly | Lifetime |
|---|---|---|---|
| Personal Self Hosted | Unlimited | Free | Free |
| Team | 3 | $499 | $1,349 |
| Unlimited | Unlimited | $999 | $2,999 |
You do not get extra dashboard features versus the free build today. A host is one monitored connection; replicas in the same shard are not counted.
Details: Editions · Commercial license · Buy.
Self-hosting is free under GPL-3.0. Sponsorship is not a license — it buys no features, no support window, and no key. It funds the free build, and it earns a listing.
| Tier | One-off | You get |
|---|---|---|
| Supporter | $19 | Your name on the sponsors page |
| Backer | $59 | Your name and a link to your site on the sponsors page |
| Hero | $99 | Your logo and link under the homepage hero, plus the sponsors page |
| Partner | $199 | A larger hero slot, plus a short line about you on the sponsors page |
Want to support the free build? Start sponsoring — from $19 one-off, or $99 to put your logo under the homepage hero.
The wall: chmonitor.dev/sponsors. A commercial license is a separate thing — see Editions.
- Getting started — ClickHouse user, system tables, first run
- Deploy — Docker, Kubernetes, Workers, one-click
- AI agent — tools, skills, env
- MCP clients — Claude, Cursor, and other clients
- Editions — what a license does and does not unlock
- Commercial license — SKUs, prices,
CHM_LICENSE_KEY - Sponsors — the sponsor wall and the ladder
- Environment variables
- Connection errors
- Migrate to v0.3
- Source in this repo:
docs/content/· live site: docs.chmonitor.dev
Issues and pull requests are welcome. Agent instructions live in AGENTS.md
(CLAUDE.md includes that file).
