Skip to content

Connection Commands

Manage database connections and trigger resyncs with the Inconvo CLI.


The inconvo connection commands let you inspect, update, and resync your agent’s database connections.

Show metadata for a specific connection.

Terminal window
npx inconvo connection get --agent agt_123 --connection conn_456

If --connection is omitted, the CLI will prompt you to select from available connections.

Connection details:
My Database conn_456
status: ACTIVE
owner: My Agent
shared: no
editable: yes

List all connections for an agent.

Terminal window
npx inconvo connection list --agent agt_123

List connections that can be shared with other agents.

Terminal window
npx inconvo connection list-shareable --agent agt_123

Link a shared connection to an agent.

Terminal window
npx inconvo connection link --agent agt_123 --connection conn_456

Unlink a shared connection from an agent.

Terminal window
npx inconvo connection unlink --agent agt_123 --connection conn_456

Trigger a full database resync for a connection. This re-reads the schema from your database and updates the local .inconvo/ snapshot.

Terminal window
npx inconvo connection sync --agent agt_123 --connection conn_456

If --connection is omitted, the CLI will prompt you to select from available connections.

Update a connection’s description.

Terminal window
# Set a description
npx inconvo connection update --agent agt_123 --connection conn_456 \
--description "Production analytics database"
# Clear the description
npx inconvo connection update --agent agt_123 --connection conn_456 \
--clear-description

All connection commands support these options:

OptionDescription
--agent <agentId>Target agent ID
--connection <connectionId>Target connection ID
--jsonPrint JSON output
--api-key <apiKey>API key override