Command Line Tools
- Capella Operational
- reference
Use Couchbase command line tools to import and export data, manage backups, and interact with your cluster from the command line.
Couchbase Server includes a suite of command line tools, available as a separate package for Couchbase Capella. Couchbase command line tools for Capella include cbimport and cbexport, cbbackupmgr, cbdatarecovery, and cbq, as well as Couchbase Shell (cbsh) and cbc Tools.
Couchbase Shell
Couchbase Shell (cbsh) is an interactive command-line tool for working with Couchbase Server and Capella operational clusters.
Use cbsh to:
-
Run SQL++ queries against your cluster.
-
Import and export data in multiple formats.
-
Manage documents, buckets, scopes, and collections.
-
Manage Capella clusters, projects, and credentials.
-
Perform vector searches.
To download, install, and get started with cbsh, see the Couchbase Shell Documentation.
Couchbase Command Line Tools
The following command line tools are included in the Couchbase Server command line tools package:
cbimportandcbexport-
Import and export data in JSON and CSV format.
cbimportsupports importing from files or URLs;cbexportsupports exporting to files. cbbackupmgr-
Back up and restore data from Couchbase Server and Capella clusters.
cbbackupmgrsupports full and incremental backups, as well as point-in-time restore. cbdatarecovery-
Recover data from offline or failed-over nodes.
cbq-
An interactive shell for running SQL++ queries against Couchbase Server and Capella clusters.
Download and Install Command Line Tools
Download the command line tools package that corresponds to the server version you’re using.
| While command line tools for 7.6.X are not forward compatible with 8.0.X, command line tools for 8.0.X are backward compatible with 7.6.X. |
-
Couchbase Server 8.0.X
-
Couchbase Server 7.6.X
- Linux
-
https://packages.couchbase.com/releases/8.0.1/couchbase-server-dev-tools-8.0.1-linux_x86_64.tar.gz
- Linux aarch64
-
https://packages.couchbase.com/releases/8.0.1/couchbase-server-dev-tools-8.0.1-linux_aarch64.tar.gz
- macOS x86
-
https://packages.couchbase.com/releases/8.0.1/couchbase-server-dev-tools-8.0.1-macos_x86_64.zip
- macOS arm64
-
https://packages.couchbase.com/releases/8.0.1/couchbase-server-dev-tools-8.0.1-macos_arm64.zip
- Windows
-
https://packages.couchbase.com/releases/8.0.1/couchbase-server-dev-tools-8.0.1-windows_amd64.zip
On Windows, you need a recent Microsoft Visual C++ Redistributable installed. Download the latest Visual C++ Redistributable from Microsoft Visual C++ Redistributable latest supported downloads.
Unzip or untar the packages, and the binaries are ready to run.
The extracted package also contains a README file and the software licenses.
For example, for Linux x86_64:
$ wget https://packages.couchbase.com/releases/8.0.1/couchbase-server-dev-tools_8.0.1-linux_x86_64.tar.gz$ tar -xf couchbase-server-dev-tools_8.0.1-linux_x86_64.tar.gz$ ls -1
bin
couchbase-server-dev-tools_8.0.1-linux_x86_64.tar.gz
lib
LICENSE.txt
NOTICES.txt
README.txt
share$ cd bin$ ls -1
cbbackupmgr
cbdatarecovery
cbexport
cbimport
cbq$ ./cbimport --version
cbimport version 8.0.1-4792 (983714b2)$ ./cbexport --version
cbexport version 8.0.1-4792 (983714b2)$ ./cbbackupmgr --version
cbbackupmgr version 8.0.1-4792 (983714b2)$ ./cbdatarecovery --version
cbdatarecovery version 8.0.1-4792 (983714b2)$ ./cbq --version
GO VERSION : go1.25.5
SHELL VERSION : 8.0.1-4792
Use N1QL queries select version(); or select min_version(); to display server version.- Linux
-
https://packages.couchbase.com/releases/7.6.11/couchbase-server-dev-tools-7.6.11-linux_x86_64.tar.gz
- Linux aarch64
- macOS x86
-
https://packages.couchbase.com/releases/7.6.11/couchbase-server-dev-tools-7.6.11-macos_x86_64.zip
- macOS arm64
-
https://packages.couchbase.com/releases/7.6.11/couchbase-server-dev-tools-7.6.11-macos_arm64.zip
- Windows
-
https://packages.couchbase.com/releases/7.6.11/couchbase-server-dev-tools-7.6.11-windows_amd64.zip
On Windows, you need a recent Microsoft Visual C++ Redistributable installed. Download the latest Visual C++ Redistributable from Microsoft Visual C++ Redistributable latest supported downloads.
Unzip or untar the packages, and the binaries are ready to run.
The extracted package also contains a README file and the software licenses.
For example, for Linux x86_64:
$ wget https://packages.couchbase.com/releases/7.6.11/couchbase-server-dev-tools_7.6.11-linux_x86_64.tar.gz$ tar -xf couchbase-server-dev-tools_7.6.11-linux_x86_64.tar.gz$ ls -1
bin
couchbase-server-dev-tools_7.6.11-linux_x86_64.tar.gz
lib
LICENSE.txt
NOTICES.txt
README.txt
share$ cd bin$ ls -1
cbbackupmgr
cbdatarecovery
cbexport
cbimport
cbq$ ./cbimport --version
cbimport version 7.6.11-8495 (e9a7a0ae)$ ./cbexport --version
cbexport version 7.6.11-8495 (e9a7a0ae)$ ./cbbackupmgr --version
cbbackupmgr version 7.6.11-8495 (e9a7a0ae)$ ./cbdatarecovery --version
cbdatarecovery version 7.6.11-8495 (e9a7a0ae)$ ./cbq --version
GO VERSION : go1.25.8
SHELL VERSION : 7.6.11-8495
Use N1QL queries select version(); or select min_version(); to display server version.cbc Tools
The Couchbase C SDK, libcouchbase, includes a small set of command line tools.
For more information, see cbc Tools.
See Also
Couchbase also offers plugins and extensions for popular IDEs, so you can work with your Capella cluster directly from your development environment. For a full list of available integrations, see Integrations, Connectors, and Tools.
Next Steps
To start using command line tools, do the following:
-
Copy the connection string for your cluster.
-
Configure cluster access by creating cluster access credentials.
You’ll need the username and password for the cluster credentials to connect to the cluster.
-
Add your IP address to the cluster’s list of allowed IPs.