Skip to main content
This page is generated from the synqcli command tree, so it always matches the released binary. For what the YAML declares and how to structure it, see Defining monitors in code; the field-by-field format is the configuration reference.
Manage Coalesce Quality monitors, SQL tests and deployment rules as code. A YAML configuration declares which monitors and tests belong on which assets. The deploy command reconciles a workspace with that configuration, export writes what a workspace already has back out as YAML, and advisor proposes tests for an asset. The schema command writes the JSON schema out for editor completion.

​
Global flags

These apply to every command.

​
Commands

​
synqcli advisor

Suggest data quality tests for one or more entities
The advisor command uses AI to suggest appropriate data quality tests and monitors for one or more entities (tables) based on provided instructions. Example (single entity, JSON output):
Example (single entity with YAML file output):
Example (multiple entities):
Example (with DWH connection for data profiling):
Example (filter to specific columns):
This will create separate YAML files for each entity in the output directory. When —deploy is specified, all YAML files in the output directory will be deployed. DWH CONNECTIONS: When —connections is specified, the advisor can profile columns to:
  • Discover actual values for accepted_values tests
  • Determine min/max bounds for range tests
  • Check null rates and distinct counts
Connection file format (connections.yaml):
Alternatively, configure a single connection via environment variables:
Supported types: postgres, mysql, bigquery, snowflake, clickhouse, redshift, databricks

​
synqcli auth

Manage Coalesce Quality API authentication
Manage authentication for the Coalesce Quality API. synqcli can authenticate as a human in a browser, not only with client credentials. Credentials are cached under ~/.synq/oauth/, partitioned by region, and shared with the other Coalesce Quality CLIs by default. Client credentials (—client-id / —client-secret or QUALITY_CLIENT_ID / QUALITY_CLIENT_SECRET) and a pre-issued QUALITY_TOKEN still take precedence over a browser login, so CI is unaffected. Pick a deployment with —region, or point at a staging or self-hosted deployment with —endpoint. Both work on every command, and a successful login is remembered — so after logging in to one deployment, later commands need neither flag. Examples:

​
synqcli auth login

Authenticate with Coalesce Quality in a browser
Authenticate using the OAuth2 authorization code flow with PKCE. Opens a browser, then caches the resulting credential under ~/.synq/oauth/. The login asks for only the permissions synqcli needs — managing monitors, SQL tests and query-based deployment rules, plus the reads required to resolve the assets a check targets. By default the credential goes to the shared slot, so one login serves every Coalesce Quality CLI on this machine. Pass —isolated to keep it to synqcli.

​
synqcli auth logout

Remove the stored credential for a region
Delete the cached credential for one region, leaving credentials for other regions in place. The OAuth client registration is kept, so logging back in does not create another connected app.

​
synqcli auth status

Show every stored credential, for every region
List the cached credentials across all regions, with the workspace, granted permissions and expiry of each. Reads local files only — no network calls. Pass —region or —endpoint to show one deployment instead of all of them.

​
synqcli auth token

Print the access token, refreshing it if needed
Print the current access token to stdout, refreshing it first if it has expired or is close to expiring. Useful for scripting:

​
synqcli auth use

Show or set the deployment commands use by default
Record which deployment a command talks to when it is given neither —region nor —endpoint. A successful login already records the deployment it authenticated against, so this is only needed to switch between two deployments you are logged in to. An explicit —region or —endpoint, QUALITY_API_ENDPOINT and QUALITY_REGION all still win over what is recorded here. Called with no argument it prints the current setting. Examples:

​
synqcli deploy

Deploy custom monitors from YAML configuration
Deploy custom monitors by parsing YAML configuration files. Before deploying, it prints what changes will be made and prompts for confirmation, unless —auto-confirm is set. If no files are provided, it will recursively search for YAML files from the working directory.

​
synqcli export

Export custom monitors, SQL tests, and deployment rules to YAML
Export custom monitors, SQL tests, and deployment rules as YAML. By default all three resource types are exported. Use —type to narrow:
ID-scoped flags (—monitor, —sql-test, —deployment-rule) implicitly add their owning type to the selection, so you rarely need —type explicitly.

​
synqcli schema

Generate JSON schema. The schema can be used in IDEs for autocomplete and validation.