Couchbase
Couchbase Server
Return to Learn
Developer Documentation
Couchbase Mobile
Open Source Projects
Forums
Documentation Archives
CLI reference
The Couchbase Server command-line interface (CLI) provides the following topics:
Related Links
CLI overview
Couchbase Server command-line interface (CLI) tools are provided to manage and monitor clusters, servers, vBuckets, XDCR, and so on.
couchbase-cli tool
The
couchbase-cli
tool is used to perform operations on an entire cluster.
cbanalyze-core tool
The
cbanalyze-core
tool is used to parse and analyze core dump data.
cbbackup tool
The
cbbackup
tool creates a copy of data from an entire running cluster, an entire bucket, a single node, or a single bucket on a single functioning node.
cbcollect_info tool
The
cbcollect_info
tool provides detailed statistics for a specific node.
cbdocloader tool
The
cbdocloader
tool is used to load a group of JSON documents in a given directory or in a single.zip file.
cbepctl tool
The
cbepctl
tool is used to control vBucket states, configuration, and memory and disk persistence behavior.
cbhealthchecker tool
The
cbhealthchecker
tool generates a health report named
Cluster Health Check Report
for a cluster.
cbreset_password tool
The
cbreset_password
tool is used to reset an administrative or read-only password.
cbrestore tool
The
cbrestore
tool restores data from a file to an entire cluster or to a single bucket in the cluster.
cbstats tool
The
cbstats
tool is used to get node and cluster-level statistics about performance and items in storage.
cbtransfer tool
The
cbtransfer
tool is used to transfer data between clusters and to/from files.
cbworkloadgen tool
The
cbworkloadgen
tool is used to generate random data and perform read/writes for Couchbase Server. This is useful for testing Couchbase servers and clusters.