browse
cockroach/

CockroachDB CLI

Cockroach Labs

Command line interface for managing CockroachDB distributed SQL database clusters.

Databases & DataJSON
01Install
brew install cockroachdb/tap/cockroach
Download binary →

02Global Flags
FlagTypeDescription
--urlstringConnection URL
--hoststringDatabase server host
--portstringDatabase server port
--certs-dirstringPath to certificate directory
--insecurebooleanUse insecure connection (no TLS)
--formatenum [table, csv, tsv, json, raw]Output format

03Authentication
Methods
connection-stringenvironment-variables
Env vars
COCKROACH_URLCOCKROACH_USERCOCKROACH_INSECURE
Setupcockroach sql --url <connection-string>

04Capabilities
Reference
binarycockroach
checkcockroach version
authconnection-string, environment-variables
formatstable, csv, tsv, raw
json flag--format=json