mcpField
I
infra-clickhouse

infra-clickhouse

github.com/clickhouseCloud & DevOps5624.5k installsUpdated 1w ago
Repository

About infra-clickhouse

infra-clickhouse guides agents using clickhousectl to manage local ClickHouse and ClickHouse Cloud. It routes development and production tasks to separate workflows.

Key features

  1. 01Separates local and cloud workflows
  2. 02Routes to the relevant reference
  3. 03Covers development-to-production paths
  4. 04Provides CLI installation guidance
  5. 05Documents JSON output support

Use cases

  1. 01Set up local ClickHouse for an app
  2. 02Create or operate ClickHouse Cloud services
  3. 03Move from local development to production

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/clickhouse/agent-skills --skill infra-clickhouse

After installing, type/infra-clickhousein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

metadata.json
README.md
ref/
cloud.md
local.md

Details

From the project README

ClickHouse with clickhousectl

clickhousectl manages ClickHouse in two environments:

  • Local — ClickHouse installed and running on the user's machine, for development.
  • Cloud — managed ClickHouse Cloud services, for production: fully managed, automatic scaling, backups, and upgrades.

This file routes to the right reference. The step-by-step workflows live in ref/local.md and ref/cloud.md — read the one that matches the user's situation before running commands.

Which reference to use

The user wants to...Read
Build an app with ClickHouse, develop or prototype locally, no cloud account neededref/local.md
Go to production, host a managed ClickHouse, or use ClickHouse Cloud explicitlyref/cloud.md
Operate an existing cloud service (schemas, users, queries against it)ref/cloud.md
Develop locally now, ship to production laterStart with ref/local.md; it points to ref/cloud.md when it's time to go to prod

If it's genuinely ambiguous (e.g. "set up ClickHouse for my app"), default to local for development tasks and ask before creating anything in the cloud — cloud services cost money.

Prerequisites (both workflows)

Check that clickhousectl is installed:

which clickhousectl

If not found, install it:

curl -fsSL https://clickhouse.com/cli | sh

This installs to ~/.local/bin/clickhousectl (with a chctl alias). If the command is still not found, suggest export PATH="$HOME/.local/bin:$PATH" or a new terminal.

All commands accept --json for machine-readable output. Exit codes follow gh conventions: 0 success, 1 error, 2 cancelled, 4 auth required.

Related

  • When designing schemas, consult the clickhouse-best-practices skill for ORDER BY selection, data types, and partitioning.
  • For Postgres (local development or managed ClickHouse Cloud Postgres), use the infra-postgres skill.

Comments

Markdown supported