Skip to content

CLI Reference

The strake-cli is the primary tool for managing your Strake configuration, validating metadata, and performing GitOps-style deployments.

Project Lifecycle

init

strake-cli init command

Initialize a new Strake project with a template configuration.

Options:

--template : sql | rest | file | grpc, optional
The type of project template to generate as a starting point.

GitOps & Deployment

validate

strake-cli validate [file] command

Check your configuration for syntax and connectivity errors without applying changes.

Options:

file : str, default: sources.yaml
Path to the configuration file to validate.
--offline : bool, default: false
Skip network connectivity checks and perform only local schema validation.

diff

strake-cli diff [file] command

Preview the differences between your local configuration and the live metadata store.

Options:

file : str, default: sources.yaml
Path to the configuration file to compare.

apply

strake-cli apply [file] command

Deploy your local configuration to the metadata store.

Options:

file : str, default: sources.yaml
Path to the configuration file to deploy.
--force : bool, default: false
Required for potentially destructive actions (e.g., mass-deleting sources).
--dry-run : bool, default: false
Preview changes in the registry without actually persisting them.
--expected-version : int, optional
Enforces optimistic locking. The operation will fail if the current version in the metadata store does not match this value.

Discovery & Inspection

strake-cli search <source> [file] command

Search for tables and schemas in an upstream source.

Options:

source : str
The name of the source to search.
--domain : str, optional
Narrow the search scope to a specific domain.

add

strake-cli add <source> <table> [file] command

Automatically adds a discovered table into your sources.yaml.

Options:

source : str
The name of the source.
table : str
The full name of the table to add (e.g., schema.table).

introspect

strake-cli introspect <source> [file] command

Describe the physical schema of a specific upstream source.

Options:

--registered : bool, default: false
If true, introspect a source that is already registered in the metadata store instead of the local config.

Domain Management

domain list

strake-cli domain list command

List all registered domains currently tracked in the metadata store.

domain history

strake-cli domain history command

Show the audit trail of deployment events for a domain.

Options:

--name : str, default: default
The name of the domain to inspect.

domain rollback

strake-cli domain rollback --to-version <n> command

Revert a domain to a previous known-good version.

Options:

--to-version : int
Required. The specific target version to revert to.