Skip to content
chkit Docs

Getting Started

Prerequisites

Section titled “Prerequisites”
  • Bun 1.3.5+
  • A ClickHouse endpoint

Install

Section titled “Install”
Terminal window
bun install
bun run build
bun run chkit --help

Quick Start

Section titled “Quick Start”
Terminal window
bun run chkit init
bun run chkit generate --name init
bun run chkit migrate
bun run chkit migrate --apply
bun run chkit status
bun run chkit check

AI Agent Skill

Section titled “AI Agent Skill”

Install the chkit agent skill so AI coding assistants (Claude Code, Cursor, GitHub Copilot, Codex) understand chkit commands, schema DSL, and workflows:

Terminal window
npx skills add obsessiondb/chkit

This installs the skill into your project’s agent configuration directory (e.g. .claude/skills/chkit/).

Next

Section titled “Next”