A newer version of this documentation is available.

View Latest

CLI Reference

      Couchbase Server command-line interface (CLI) tools are provided to manage and monitor clusters, servers, vBuckets, XDCR, and so on.

      By default, the CLI tools are installed into the following locations on each platform:

      Operating System Directory Locations


      /opt/couchbase/bin, /opt/couchbase/bin/install, and /opt/couchbase/bin/tools


      C:\Program Files\couchbase\server\bin, C:\Program Files\couchbase\server\bin\install, and 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 either the couchbase-cli tool or the cbcollect_info cbcollect_info tool.