Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

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

      Linux

      • /opt/couchbase/bin

      • /opt/couchbase/bin/install

      • /opt/couchbase/bin/tools

      Windows

      • 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 Server.app/Contents/Resources/couchbase-core/bin

      • /Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin/tools

      • /Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin/install

      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 the Server developer tools package and the Server admin tools package.

      Server Developer Tools Package

      The Server developer tools package lets you install the following EE Server utilities on the 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:

      wget https://packages.couchbase.com/releases/7.6.4/couchbase-server-dev-tools-7.6.4-linux_x86_64.tar.gz

tar -xf couchbase-server-dev-tools-7.6.4-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.

      Server Admin Tools Package

      The Server admin tools package lets you install the following Server utilities on the 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:

      wget https://packages.couchbase.com/releases/7.6.4/couchbase-server-admin-tools-7.6.4-linux_x86_64.tar.gz

tar -xf couchbase-server-admin-tools-7.6.4-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.

      For the Server developer tools package, the 7.6.4 version of the utilities cbimport, cbexport, cbbackupmgr, and cbq are compatible with the following Couchbase Server versions:

      • 7.6.0, 7.6.1, 7.6.2, 7.6.3

      • 7.2.x

      • 7.1.x

      • 7.0.x

      You can download and use the latest version of the utilities (cbimport, cbexport, cbbackupmgr, and cbq) with earlier Couchbase Server versions.

      For the Server admin tools package, do the following:

      • Use the --version option to get the version of the utility. However, for the cbc utility, use the cbc version option.

      • couchbase-cli is a utility for administering the Couchbase cluster. Make sure that the versions of couchbase-cli and the Couchbase cluster match.

      • For all utilities, a feature that exists in a latest Server version only is not supported by an earlier version utility.