CLI examples¶

This page contains practical command examples for day-to-day dpone usage.

Validate a manifest¶

dpone manifest validate examples/batch/landing_orders.batch.yaml

The command validates the manifest structure, load strategy, source/sink configuration, and optional sections such as state, schema evolution, reconciliation, quality, and observability.

Explain a manifest¶

dpone manifest explain examples/batch/landing_orders.batch.yaml --format text

Use this before running a pipeline to confirm resolved defaults, dependency edges, selected strategies, and runtime wiring.

Generate a dry-run execution plan¶

dpone plan examples/batch/landing_orders.batch.yaml --format md

The plan is read-only. It shows the source boundary, staging/shadow table path, schema evolution actions, reconciliation behavior, state transitions, partitioning, and quality checks.

Run a batch manifest locally¶

dpone batch run examples/batch/landing_orders.batch.yaml

For production usage, prefer running through your orchestrator and keep credentials in a secret backend.

Inspect runtime dependencies¶

dpone doctor --profile local

The doctor command checks optional extras, local clients such as bcp and clickhouse-client, Docker availability, and configured credentials. Secrets are always redacted.

Inspect state¶

dpone state inspect --backend postgres --connection-id state_postgres --state-kind run

State commands support inspect, export, compare, replay-from, and guarded destructive reset operations.

Reset state with an explicit guard¶

dpone state reset --backend mssql --connection-id state_mssql --state-kind kafka_offsets --yes

Destructive state operations require --yes. Use dpone plan or state export first when preparing a migration.

Connector certification¶

dpone connectors certify --connector mssql --mode mock_local --format md

Certification creates a reproducible artifact with supported strategies, schema evolution coverage, delete handling, state support, and benchmark notes.

Performance advice¶

dpone perf advise examples/batch/postgres_to_mssql.yaml --format text

The advisor suggests partitioning, batch size, native bulk paths, ClickHouse direct TSV/HTTP loading, Kafka producer settings, and state/reconciliation tuning.