Sync CLI
chkit Sync (beta) uses chkit registry to discover templates, chkit add to install them, and chkit ingest to operate exported streams.
Commands
Section titled “Commands”| Command | Purpose |
|---|---|
chkit registry list | Browse available provider templates and their coverage |
chkit registry inspect <name> | Inspect credential setup, destination tables, copied files, and dependencies |
chkit registry build | Build versioned template artifacts for a custom registry |
chkit add <name> | Copy an editable provider template into a TypeScript project |
chkit ingest list | List exported streams and their selection tags |
chkit ingest run | Execute selected streams once |
chkit ingest status | Read stream checkpoints from the configured journal |
chkit ingest doctor | Diagnose selected journal histories |
chkit ingest repair | Preview or materialize a reviewed journal repair |
chkit ingest <subcommand> is an alias for chkit plugin ingest <subcommand> and requires the ingestion plugin in clickhouse.config.ts. Registry browsing does not require a project config or database connection.
First run
Section titled “First run”Inspect and install a template in a TypeScript project:
bunx chkit registry inspect attiobunx chkit add attio --with-testsConfigure the provider credentials and direct ClickHouse connection as described in the integration guide. Create destination tables through chkit Schema, reviewing the generated SQL before applying it:
bunx chkit ingest listbunx chkit generate --name add-attiobunx chkit migrate --jsonbunx chkit migrate --applybunx chkit ingest run --tag provider:attiobunx chkit ingest status --tag provider:attiogenerate and migrate belong to chkit Schema; they prepare the destination schema. Template installation does not run migrations, access the provider, or schedule future runs.
Shared flags
Section titled “Shared flags”The CLI shares global flags, including --config and --json. Each command reference documents its own flags and output. Use --tag on ingestion commands to select streams; repeat it to require every supplied tag.
Related pages
Section titled “Related pages”- chkit Sync (beta): product scope and starting points.
chkit ingest: stream flags, exit codes, and JSON output.chkit add: installation, ownership, and conflicts.chkit registry: template discovery and publishing commands.- Scheduling and recovery: recurring runs and recovery workflows.