Skip to main content
canonic connection manages the entries under connections: in canonic.yaml; the same file canonic setup writes to during onboarding.

connection list

List configured connections.
canonic connection list
Shows each connection’s id, type, whether it’s the project default, and its params. With --json, returns {"connections": [...]} including full param dicts.

connection test

Test connectivity for one or all connections.
canonic connection test
canonic connection test --connection warehouse
FlagDescription
--connection, -cConnection id to test (default: all).
Exits non-zero if any tested connection fails to connect.

connection add

Add a new source connection to canonic.yaml.
canonic connection add --id warehouse --type postgres \
  --param host=localhost --param database=analytics \
  --credentials-ref env:WAREHOUSE_PASSWORD --set-default
FlagDescription
--idUnique connection identifier.
--typeConnector type (sqlite, postgres, …).
--param, -pConnector param as KEY=VALUE (repeatable).
--credentials-refCredential reference (env:VAR, keyring:service, file:path).
--set-defaultMake this the project default connection.

connection remove

Remove a configured connection from canonic.yaml.
canonic connection remove warehouse
Takes the connection id as a positional argument. If it was the project default, the default is cleared.