Getting Started
chkit is a ClickHouse schema and migration toolkit for TypeScript projects. Pick the path that matches what you’re working on.
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, optionallyCLICKHOUSE_USER,CLICKHOUSE_PASSWORD) — ClickHouse 24.x or newer (see compatibility)
Where to next
Section titled “Where to next”Once either path is working:
- CLI reference — every command, flag, and expected output
- Configuration — wire up
clickhouse.config.ts - Schema DSL — define tables, views, and materialized views
- Troubleshooting — fixes for common errors if a command fails