Can I use CockroachDB as a CLI?

Yes. KosmoKrator exposes a CockroachDB CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose CockroachDB through MCP?

Yes. The KosmoKrator MCP gateway can expose selected CockroachDB tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are CockroachDB credentials stored?

CockroachDB credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for CockroachDB MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

CockroachDB CLI for Headless Automation

Use the CockroachDB CLI for headless automation with headless JSON commands, schema discovery, credentials, and permission controls.

7 functions 6 read 1 write Bearer token auth

Submit CockroachDB feedback View package source

CockroachDB CLI for Headless Automation

Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers.

Use headless automation when another tool needs a stable local command surface. The CockroachDB CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.

Command Shape

# CockroachDB CLI for Headless Automation
kosmokrator integrations:configure cockroachdb --set access_token="$COCKROACHDB_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmo integrations:call cockroachdb.cockroachdb_list_clusters '{}' --json

Discovery Before Execution

Agents and scripts can inspect CockroachDB docs and schemas before choosing a function.

kosmo integrations:docs cockroachdb --json
kosmo integrations:docs cockroachdb.cockroachdb_list_clusters --json
kosmo integrations:schema cockroachdb.cockroachdb_list_clusters --json
kosmo integrations:search "CockroachDB" --json
kosmo integrations:list --json

Useful CockroachDB CLI Functions

Function	Type	Parameters	Description
`cockroachdb.cockroachdb_list_clusters`	Read	none	List all CockroachDB clusters in the organization. Returns cluster IDs, names, status, cloud provider, and regions.
`cockroachdb.cockroachdb_get_cluster`	Read	cluster_id	Get details for a specific CockroachDB cluster by ID. Returns full cluster information including configuration, nodes, and connection strings.
`cockroachdb.cockroachdb_create_cluster`	Write	name, cloud_provider, region, plan, spend_limit, cluster_version	Create a new CockroachDB cluster. Requires a name, cloud provider, and region configuration.
`cockroachdb.cockroachdb_list_databases`	Read	cluster_id	List all databases in a CockroachDB cluster. Returns database names, sizes, and table counts.
`cockroachdb.cockroachdb_get_database`	Read	cluster_id, database_name	Get details for a specific database in a CockroachDB cluster. Returns table list, sizes, and configuration.
`cockroachdb.cockroachdb_list_users`	Read	cluster_id	List all SQL users in a CockroachDB cluster. Returns usernames and privileges.
`cockroachdb.cockroachdb_get_current_user`	Read	none	Get information about the current authenticated CockroachDB Cloud user, including email, name, and organization role.

Automation Notes

Use --json for machine-readable output.
Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
Configure read/write policy before unattended runs; use --force only for trusted automation.
Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.

Related CockroachDB CLI Pages

CI CockroachDB CLI for CI. Cron Jobs CockroachDB CLI for cron jobs. Shell Scripts CockroachDB CLI for shell scripts. Coding Agents CockroachDB CLI for coding agents.