Skip to content

chkit status

Reports the current migration state by comparing migration files on disk against the journal. Does not connect to ClickHouse.

chkit status [flags]

No command-specific flags. See global flags.

chkit status reads the migrations directory and journal.json to compute:

  • Total migration files (.sql files in migrationsDir, sorted alphabetically)
  • Applied migrations (entries recorded in the journal)
  • Pending migrations (on disk but not yet applied)
  • Checksum mismatches (applied migrations whose SHA-256 checksum no longer matches the file on disk)

This command is read-only and does not require a ClickHouse connection.

Terminal window
chkit status
Migrations: 5 total, 3 applied, 2 pending
Checksum mismatches: 0
Terminal window
chkit status --json
CodeMeaning
0Always succeeds
{
"command": "status",
"schemaVersion": 1,
"migrationsDir": "/absolute/path/to/migrations",
"total": 5,
"applied": 3,
"pending": 2,
"pendingMigrations": ["0004_add_column.sql", "0005_create_index.sql"],
"checksumMismatchCount": 0,
"checksumMismatches": []
}

When checksum mismatches are detected, each entry includes the migration name, expected checksum (from the journal), and actual checksum (from the file on disk).