type-bridge-cli

The type-bridge command-line interface for split-YAML workspaces, generated bindings, and canonical schema migrations. Schema checking, generation, and migration authoring/planning are offline; apply, verify, and adopt connect only through an explicitly selected workspace environment.

Install and start

cargo install type-bridge-cli --version 2.2.1 --locked
type-bridge --help
type-bridge schema check
type-bridge schema generate

Run commands from a workspace containing typebridge.yaml, or pass --manifest <path>. Keep credentials as symbolic environment references and enable migration access explicitly in the chosen environment. The same entry point is available to Rust integrators as type_bridge_cli::run_cli.

Binding-neutral attribute backfills are authored from a closed YAML intent stored directly in the configured migration directory:

format: typebridge.migration-backfill-intent/v1
copy-attribute:
  owner-kind: entity
  owner: person
  source: legacy-name
  destination: display-name
  partition-key: person-id
  batch-rows: 128
  reverse: remove-equal-copied-destination

After the schema history reaches the current Split-YAML state, publish the reviewed intent with:

type-bridge migration make --name copy-name \
  --backfill-intent copy-name.backfill.yaml

The intent filename must be a regular direct child of the migration directory. The historical owner must have the partition attribute as an effective key, and the committed head must still equal the current schema sources. The CLI serializes discovery, parsing, generation, and no-overwrite publication under one directory lock.

The crate has no optional features. It is released in lockstep with TypeBridge 2.2.1 and requires Rust 1.88+. Offline schema checking, generation, migration authoring, and planning accept the frozen TypeDB 3.11.5 and 3.12.1 semantic profiles. Connected migration apply, verify, and adopt require exactly TypeDB 3.12.1.

Repository · API documentation · MIT license