CLI: Connectors
Generated from deedglass help --json (CLI 0.1.0-dev). Global flags and exit codes are on the CLI reference page.
deedglass connector create
Section titled “deedglass connector create”Add a connector.
deedglass connector create --config <file> [--type rest] [--name orders] [--description …] [--json]| Flag | Type | Default | What it does |
|---|---|---|---|
--config |
string | a YAML or JSON file: the config, or a document with type, name and config | |
--description |
string | what the connector is for, up to 500 characters | |
--name |
string | the connector name, used as the tool prefix: orders → orders.get | |
--type |
string | the connector type (rest) |
Add --json for machine-readable output.
deedglass connector list
Section titled “deedglass connector list”List connectors.
deedglass connector list [--json]Add --json for machine-readable output.
deedglass connector show
Section titled “deedglass connector show”Show one connector.
deedglass connector show <name|con_…> [--json]Add --json for machine-readable output.
deedglass connector test
Section titled “deedglass connector test”Test a connector’s credentials.
deedglass connector test <name|con_…> [--json]Add --json for machine-readable output.
deedglass connector types
Section titled “deedglass connector types”List connector types.
deedglass connector types [--type stripe] [--json]| Flag | Type | Default | What it does |
|---|---|---|---|
--type |
string | show one type: its tools, credentials, setup and limits |
Add --json for machine-readable output.
deedglass connector credentials set
Section titled “deedglass connector credentials set”Store a connector’s credentials.
deedglass connector credentials set <name|con_…> --from-env VAR | --stdin | --field KEY=env:VAR|file:PATH|stdin... [--kind bearer] [--json]Add --json for machine-readable output.
deedglass connector credentials remove
Section titled “deedglass connector credentials remove”Delete a connector’s credentials.
deedglass connector credentials remove <name|con_…> [--json]Add --json for machine-readable output.
deedglass connector postgres init
Section titled “deedglass connector postgres init”Prepare a Postgres database.
deedglass connector postgres init --connector <name> [--admin-dsn-env DEEDGLASS_INIT_DSN] [--config <file>] [--apply] [--confirm <database>] [--rotate-passwords] [--dsn-host host:port] [--no-store] [--json]| Flag | Type | Default | What it does |
|---|---|---|---|
--admin-dsn-env |
string | DEEDGLASS_INIT_DSN |
the environment variable holding the admin DSN (read once, never stored) |
--apply |
bool | apply the plan in one transaction | |
--config |
string | read the connector’s config from this YAML or JSON file instead of the server | |
--confirm |
string | the database name, typed exactly: required to apply to a remote, non-throwaway database | |
--connector |
string | the postgres connector’s name | |
--dsn-host |
string | host:port the Deedglass server reaches the database at, when it differs from the admin DSN’s (a Docker service name, a private DNS name) | |
--no-store |
bool | write the DSNs to .deedglass/pg- |
|
--plan-dir |
string | .deedglass/plans |
where the reviewable plan is written |
--rotate-passwords |
bool | give deedglass_agent and deedglass_witness new passwords and store new DSNs |
Add --json for machine-readable output.
deedglass connector postgres check
Section titled “deedglass connector postgres check”Check a prepared Postgres database.
deedglass connector postgres check --connector <name> [--json] · --dsn-env VAR [--witness-dsn-env VAR] [--config <file>] [--probe] [--json]| Flag | Type | Default | What it does |
|---|---|---|---|
--config |
string | local mode: the connector’s config file (else read from the server) | |
--connector |
string | the postgres connector’s name | |
--dsn-env |
string | local mode: check with the DSN in this environment variable instead of the server | |
--probe |
bool | local mode: run begin_action in a transaction that is rolled back | |
--witness-dsn-env |
string | local mode: the witness DSN’s environment variable |
Add --json for machine-readable output.
deedglass connector gmail authorize
Section titled “deedglass connector gmail authorize”Authorize the Gmail connector.
deedglass connector gmail authorize <name> --client-file ./client_secret.json [--readonly] [--no-browser] [--json]| Flag | Type | Default | What it does |
|---|---|---|---|
--client-file |
string | the Desktop-app OAuth client JSON from Google Cloud | |
--no-browser |
bool | print the sign-in link instead of opening a browser | |
--readonly |
bool | also ask for gmail.readonly, so agents can read threads (gmail.get_thread) |
Add --json for machine-readable output.
deedglass decoder status
Section titled “deedglass decoder status”Show what the decoder reads from Postgres.
deedglass decoder status [--connector <name>] [--recent N] [--json]| Flag | Type | Default | What it does |
|---|---|---|---|
--connector |
string | one connector’s decoder, in detail | |
--recent |
int | 0 |
show the newest N frames (0 to 50; with –connector) |
Add --json for machine-readable output.
deedglass decoder drop
Section titled “deedglass decoder drop”Drop a connector’s replication slot.
deedglass decoder drop --connector <name> [--confirm <name>] [--json]| Flag | Type | Default | What it does |
|---|---|---|---|
--confirm |
string | the connector’s name again, instead of typing it (scripts) | |
--connector |
string | the connector whose slot to drop |
Add --json for machine-readable output.
deedglass slack manifest
Section titled “deedglass slack manifest”Print the Slack app manifest.
deedglass slack manifest --base-url <https://host> [--name Deedglass] [--json]| Flag | Type | Default | What it does |
|---|---|---|---|
--base-url |
string | your Deedglass server’s public HTTPS URL, like https://deedglass.example.com |
|
--name |
string | Deedglass |
the app’s name in Slack (at most 35 characters) |
Add --json for machine-readable output.