CLI Reference

      The command-line interface (CLI) tools let you manage and monitor your Couchbase Server installation including clusters, servers, vBuckets, and XDCR.

      The Couchbase Server installation process installs the command-line tools. After installation, the location of these tools depends on your platform:

      Operating System Directory Locations


      • /opt/couchbase/bin

      • /opt/couchbase/bin/install

      • /opt/couchbase/bin/tools


      • C:\Program Files\couchbase\server\bin

      • C:\Program Files\couchbase\server\bin\install

      • C:\Program Files\couchbase\server\bin\tools

      Mac OS X

      • /Applications/Couchbase

      • /Applications/Couchbase

      • /Applications/Couchbase

      Managing Diagnostics

      The command-line interface provides commands to start, stop, and report status for log collection. You can collect diagnostics through the command-line interface by using the couchbase-cli or the cbcollect_info tool.

      Server Tools Packages

      For convenience, Couchbase provides a tools package that contains the following utilities:

      This package lets you install these tools on systems where you have not installed Couchbase Server.

      Download the command line tools package for your platform from the following links:

      Unzip or untar the packages, and the binaries are ready to run. For example:

      tar -xf couchbase-server-tools_7.6.2-linux_x86_64.tar.gz

      Each package also contains a README file and a copy of the software license.

      On Windows, you must have a recent version of the Microsoft Visual C++ Redistributable runtime libraries installed. If you do not have these libraries installed, download them from Microsoft Visual C++ Redistributable latest supported downloads.

      Version Compatibility

      The versions of the utilities installed by the tools package are the same as the corresponding Couchbase Server installation package.

      The 7.6.2 cbimport, cbexport, cbbackupmgr, and cbq utilities are compatible with the following Couchbase Server versions:

      • 7.6.0, 7.6.1

      • 7.2.x

      • 7.1.x

      • 7.0.x