Open-source operational advisor for ClickHouse — real-time monitoring plus AI-driven index/partition/materialized-view recommendations.
290
stars
3,866
commits
TypeScript
primary language
Sep 9, 2026
updated
README
chmonitor
The operational advisor for ClickHouse
Live demo · Website · Docs · Getting started · Quick start
Watch the v0.3 launch film · 36 seconds · MP4
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.0. Upgrading from v0.2? See Migrate to v0.3.
What it does
| 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
Quick start
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:v0.3.0
Open http://localhost:3000. Pin a version tag in production; use :latest only if you want the rolling tip.
Want a look first? dash.chmonitor.dev — no setup.
Install the CLI:
curl -sSf https://chmonitor.dev/install.sh | bash
chm doctor
Deploy
Same 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.
Editions
One codebase. Community is free forever (GPL-3.0). An optional license unlocks enterprise gates — same binary.
| Community | Enterprise | |
|---|---|---|
| Cost | Free, GPL-3.0 | Priced by host count |
| Where it runs | Your infra | Same |
| ClickHouse hosts | Unlimited | Personal · Team 3 · Unlimited |
| AI advisor, agent, MCP | Included | Same, plus enterprise gates |
Details: Editions.
Screenshots
Docs
- 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
- Environment variables
- Connection errors
- Migrate to v0.3
- Source in this repo:
docs/content/· live site: docs.chmonitor.dev
Contribute
Issues and pull requests are welcome. Agent instructions live in AGENTS.md
(CLAUDE.md includes that file).
License
Contributors
Similar repos
Languages
TypeScript
78.6%
HTML
8.8%
JavaScript
7.5%
Rust
2.0%
Astro
1.9%
Open-source operational advisor for ClickHouse — real-time monitoring plus AI-driven index/partition/materialized-view recommendations.
290
stars
3,866
commits
TypeScript
primary language
Sep 9, 2026
updated
README
chmonitor
The operational advisor for ClickHouse
Live demo · Website · Docs · Getting started · Quick start
Watch the v0.3 launch film · 36 seconds · MP4
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.0. Upgrading from v0.2? See Migrate to v0.3.
What it does
| 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
Quick start
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:v0.3.0
Open http://localhost:3000. Pin a version tag in production; use :latest only if you want the rolling tip.
Want a look first? dash.chmonitor.dev — no setup.
Install the CLI:
curl -sSf https://chmonitor.dev/install.sh | bash
chm doctor
Deploy
Same 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.
Editions
One codebase. Community is free forever (GPL-3.0). An optional license unlocks enterprise gates — same binary.
| Community | Enterprise | |
|---|---|---|
| Cost | Free, GPL-3.0 | Priced by host count |
| Where it runs | Your infra | Same |
| ClickHouse hosts | Unlimited | Personal · Team 3 · Unlimited |
| AI advisor, agent, MCP | Included | Same, plus enterprise gates |
Details: Editions.
Screenshots
Docs
- 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
- Environment variables
- Connection errors
- Migrate to v0.3
- Source in this repo:
docs/content/· live site: docs.chmonitor.dev
Contribute
Issues and pull requests are welcome. Agent instructions live in AGENTS.md
(CLAUDE.md includes that file).
License
Similar repos
Contributors
Languages
TypeScript
78.6%
HTML
8.8%
JavaScript
7.5%
Rust
2.0%
Astro
1.9%