Skip to content
ch-kit Docs

Getting Started

chkit is a ClickHouse schema and migration toolkit for TypeScript projects. Pick the path that matches what you’re working on.

Let an agent set it up

Section titled “Let an agent set it up”

If you work in an AI coding agent (Claude Code, Cursor, Codex, and others), let it do the setup. Copy this prompt and paste it into your agent — it fetches chkit’s agent instructions and walks you through install, config, plugins, and your first migration.

Set up chkit (ClickHouse schema management) in this repo. First fetch https://chkit.obsessiondb.com/ai-agents.md and follow the instructions there: install the agent skill, scaffold the config, recommend any plugins this project needs, and walk me through the first migration. Don't apply anything to the database without confirming with me first.

Prefer to do it yourself? Pick a path below.

Start with an example Scaffold a working chkit project from a curated example with create-chkit. Best for a first look or as a reference setup to copy from.
Add to an existing project Install chkit alongside your application code, generate your first migration, and apply it. Best if you already have a TypeScript project.

Prerequisites

Section titled “Prerequisites”

Both paths need the same baseline:

  • Node.js 20+ or Bun 1.3.5+
  • A ClickHouse endpoint (CLICKHOUSE_URL, optionally CLICKHOUSE_USER, CLICKHOUSE_PASSWORD) — ClickHouse 24.x or newer (see compatibility)

Where to next

Section titled “Where to next”

Once either path is working: