Reference
CLI
The public surface is nine commands
trellara --help lists nine commands. They are the supported CLI, and the documented loop through them is init → check → preflight → run → verify → status.
| Command | Purpose |
|---|---|
trellara check | Inspect CDC readiness, slot posture, WAL risk, and failover-slot safety |
trellara init | Create a brokerless local Trellara flow config |
trellara run | Run bootstrap, relay, apply, and optional verify for a configured flow |
trellara fleet | Summarize verified replication topology across multiple flow configs |
trellara config | Migrate and safely inspect versioned configuration |
trellara lake | Plan and run lakehouse fan-in from verified transactions |
trellara preflight | Check source and target contracts before CDC starts |
trellara status | Show flow health, recovery actions, and proof evidence |
trellara verify | Compare source and target tables and record checksum evidence |
Every visible command in full
trellara check
Inspect CDC readiness, slot posture, WAL risk, and failover-slot safety
| Flag | Values | Default |
|---|---|---|
--config | value | unset |
--format | html · json · text | json |
--output | value | unset |
--database-url | value | unset |
--target-database-url | value | unset |
--source-id | value | ad-hoc-source |
--database-id | value | postgres |
--dataset-id | value | ad-hoc |
--publication | value | trellara_publication |
--slot | value | trellara_slot |
--capture | value | pgoutput |
--wal-retention-warn-bytes | value | unset |
--table | repeatable | required unless --config |
--write-init | value | unset |
--force | flag | unset |
trellara init
Create a brokerless local Trellara flow config
| Flag | Values | Default |
|---|---|---|
--source-database-url | value | required |
--target-database-url | value | unset |
--source-id | value | local-source |
--database-id | value | postgres |
--dataset-id | value | default |
--publication | value | trellara_publication |
--slot | value | trellara_slot |
--stream-path | value | ./target/trellara-local-stream |
--output | value | trellara.yml |
--primary-key | value | id |
--table | repeatable | required |
--evaluate | flag | unset |
--force | flag | unset |
trellara run
Run bootstrap, relay, apply, and optional verify for a configured flow
| Flag | Values | Default |
|---|---|---|
--config | value | required |
--local | flag | unset |
--verify | flag | unset |
--format | json · text | json |
--skip-snapshot | flag | unset |
--snapshot-run-id | value | local-run-snapshot |
--create-if-missing | flag | true |
--max-transactions | value | 100 |
--max-messages | value | 100 |
trellara fleet
Summarize verified replication topology across multiple flow configs
| Subcommand | Flags or nested subcommands |
|---|---|
fleet init | --source-database-url --target-database-url --fleet-id --source-id --database-id --dataset --table --primary-key --output-dir --force |
fleet report | --config --format |
fleet scorecard | --config --format |
fleet control-plane | --config --format |
fleet identity-audit | --config --format |
fleet evidence-plan | --config --format |
trellara config
Migrate and safely inspect versioned configuration
| Subcommand | Flags or nested subcommands |
|---|---|
config migrate | --config |
config redact | --config |
trellara lake
Plan and run lakehouse fan-in from verified transactions
| Subcommand | Flags or nested subcommands |
|---|---|
lake plan | --config |
lake ddl | --config |
lake writer-plan | --config --file --epoch-id --source-bucket-count --format |
lake spark-template | spark-template current-state spark-template scd2 spark-template maintenance spark-template dashboard |
lake inspect | --config --file |
lake epoch | --config --scenario --required-source-count --offline-source-count --duplicate-replay-count --format |
lake fanin | fanin plan fanin ddl fanin epoch-spec fanin run fanin verify fanin completeness |
trellara preflight
Check source and target contracts before CDC starts
| Flag | Values | Default |
|---|---|---|
--config | value | required |
trellara status
Show flow health, recovery actions, and proof evidence
| Flag | Values | Default |
|---|---|---|
--config | value | required |
--view | flow · report · alerts · dashboard · metrics · diagnostics | flow |
--format | json · text | json |
trellara verify
Compare source and target tables and record checksum evidence
| Flag | Values | Default |
|---|---|---|
--config | value | required |
--table | value | unset |
The 47 hidden commands
These are marked hide = true in args_cli.rs. They work and they are tested; they are operator and evidence tooling rather than supported public CLI, and they may change without a version bump. We list them because you will find them anyway, and finding an undocumented command surface is worse than being told about it.
version, quickstart, mvp-check, evaluate, consistency, performance, identity-audit, evidence-registry, semantics, demo, dev, flow, contract-test, contract, schema-discover, schema, stream, native, chaos, validate, explain, bootstrap, relay, apply-schema, apply, snapshot, reseed, report, alerts, dashboard, metrics, diagnostics, source-safety, inspect-transaction, partition-local, partition-watermarks, partition-rebalance-plan, quarantine, repair, repair-plan, pilot-guide, pilot-scorecard, pilot-evidence, pilot-evidence-check, pilot-evidence-template, pilot-package, pilot.
The separate check binary
trellara-check is its own binary with its own argument parser, deliberately tiny so it can be run on an evaluation call. It takes the database URL as a positional argument.
| Argument | Values | Default |
|---|---|---|
<database_url> | value | required |
--format | html · json · text | text |
--output | value | stdout |
Generated from the repository at
347a884 by tools/gen_reference.py. If this page and the
code disagree, the code is right and this page is a bug.