Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 41 additions & 29 deletions modules/cli/pages/cli-intro.adoc
Original file line number Diff line number Diff line change
@@ -1,72 +1,84 @@
= CLI Reference
:description: Couchbase Server command-line interface (CLI) tools are provided to manage and monitor clusters, servers, vBuckets, XDCR, and so on.
:description: The command-line interface (CLI) tools let you manage and monitor your Couchbase Server installation including clusters, servers, vBuckets, and XDCR.
:tools-ver: 7.6.2

[abstract]
{description}

By default, the CLI tools are installed into the following locations on each platform:
The Couchbase Server installation process installs the command-line tools.
After installation, the location of these tools depends on your platform:

[cols="50,313"]
|===
| Operating System | Directory Locations

| Linux
| [.path]_/opt/couchbase/bin_, [.path]_/opt/couchbase/bin/install_, and [.path]_/opt/couchbase/bin/tools_
a|
* [.path]`/opt/couchbase/bin`
* [.path]`/opt/couchbase/bin/install`
* [.path]`/opt/couchbase/bin/tools`

| Windows
| [.path]_C:\Program Files\couchbase\server\bin_, [.path]_C:\Program Files\couchbase\server\bin\install_, and [.path]_C:\Program Files\couchbase\server\bin\tools_.
a|
* [.path]`C:\Program Files\couchbase\server\bin`
* [.path]`C:\Program Files\couchbase\server\bin\install`
* [.path]`C:\Program Files\couchbase\server\bin\tools`

| Mac OS X
| [.path]_/Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin_

[.path]_/Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin/tools_

[.path]_/Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin/install_
a|
* [.path]`/Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin`
* [.path]`/Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin/tools`
* [.path]`/Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin/install`
|===

== Managing diagnostics
== 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 xref:cli:cbcli/couchbase-cli.adoc[couchbase-cli] tool or the xref:cbcollect-info-tool.adoc[[.cmd]`cbcollect_info`] cbcollect_info tool.
You can collect diagnostics through the command-line interface by using the xref:cli:cbcli/couchbase-cli.adoc[`couchbase-cli`] or the xref:cbcollect-info-tool.adoc[`cbcollect_info`] tool.

[#server-tools-packages]
== Server Tools Packages

For convenience, the following EE Server utilities are also available in a tools package that you can download --
xref:tools:cbimport.adoc[cbimport], xref:tools:cbexport.adoc[cbexport], and xref:backup-restore:cbbackupmgr.adoc[cbbackupmgr].
This allows developers, testers, and others to use the tools from machines on which Couchbase Server is not installed.
For convenience, Couchbase provides a tools package that contains the following utilities:

* xref:tools:cbimport.adoc[`cbimport`]
* xref:tools:cbexport.adoc[`cbexport`]
* xref:cli:cbq-tool.adoc[`cbq`]
* xref:backup-restore:cbbackupmgr.adoc[`cbbackupmgr`]

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 through the following links:
Download the command line tools package for your platform from the following links:

* Linux: https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-linux_x86_64.tar.gz[https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-linux_x86_64.tar.gz]
* Linux aarch64: https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-linux_aarch64.tar.gz[https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-linux_aarch64.tar.gz]
* macOS: https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-macos_x86_64.zip[https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-macos_x86_64.zip]
* macOS arm64: https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-macos_arm64.zip[https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-macos_arm64.zip]
* Windows: https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-windows_amd64.zip[https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-windows_amd64.zip]
* Linux: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-linux_x86_64.tar.gz[]
* Linux aarch64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-linux_aarch64.tar.gz[]
* macOS: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-macos_x86_64.zip[]
* macOS arm64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-macos_arm64.zip[]
* Windows: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-windows_amd64.zip[]

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

[source,console]
[source,console,subs="attributes+"]
----
wget https://packages.couchbase.com/releases/7.6.0/couchbase-server-tools_7.6.0-linux_x86_64.tar.gz
wget https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-linux_x86_64.tar.gz

tar -xf couchbase-server-tools_7.6.0-linux_x86_64.tar.gz
tar -xf couchbase-server-tools_{tools-ver}-linux_x86_64.tar.gz
----

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

Note that on Windows, a recent Microsoft Visual C++ Redistributable must already have been installed.
Download the latest Visual C++ Redistributable from https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170[Microsoft Visual C++ Redistributable latest supported downloads].
NOTE: On Windows, you must have a recent version of the Microsoft Visual {cpp} Redistributable runtime libraries installed.
If you do not have these libraries installed, download them from https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170[Microsoft Visual {cpp} Redistributable latest supported downloads].

[#version-compatibility]
== Version Compatibility

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

The 7.6.0 `cbimport`, `cbexport`, and `cbbackupmgr` utilities can be run against the following Couchbase Server versions:
The {tools-ver} `cbimport`, `cbexport`, `cbbackupmgr`, and `cbq` utilities are compatible with the following Couchbase Server versions:

* 7.6.0
* 7.6.0, 7.6.1
* 7.2.x
* 7.1.x
* 7.0.x