Command Line Tools

      Use Couchbase command line tools to import and export large amounts of data, and manage ad hoc backups.

      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 cb export and cbbackupmgr.


      The procedures on this page assume the following:

      Download and Install the Couchbase Command Line Tools

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

      Unzip or untar the packages, and the binaries are ready to run. The zipped package also contains a README file, and a copy of the software licenses.

      For example, for Linux x86_64:

      $ mkdir capella_server_tools_7.6.0
      $ cd capella_server_tools_7.6.0
      $ wget
      $ tar -xf couchbase-server-tools_7.6.0-linux_x86_64.tar.gz
      $ ls -1
      $ cd bin
      $ ls -1
      $ ./cbimport --version
      cbimport version 7.6.0-2176 (8eeaccdf)
      $ ./cbexport --version
      cbexport version 7.6.0-2176 (8eeaccdf)
      $ ./cbbackupmgr --version
      cbbackupmgr version 7.6.0-2176 (8eeaccdf)

      Note, cbdatarecovery does not currently support the --version flag.

      On Windows, you will need to have a recent Microsoft Visual C Redistributable already installed. Download the latest Visual C Redistributable from Microsoft Visual C++ Redistributable latest supported downloads.

      Apple M1 Silicon

      The MacOS x86 binaries can be used on Apple Silicon Macs with Rosetta installed. If your Apple Silicon Mac does not already have Rosetta installed, you can install from the command line, using:

      softwareupdate --install-rosetta

      Other CLI Tools

      The Couchbase C SDK, libcouchbase, also includes some command line tools. For more information about these command line tools, see cbc Tools.

      Couchbase Shell (cbsh)

      The new Couchbase shell, or REPL, to interact with Couchbase Capella is now in public beta.

      Use cbsh to:

      • Extract, transform, and load different data formats.

      • Export data as JSON or CSV.

      • Import data from SQLite.

      Use cbsh through development and production, for generating data and checking the status of your indexes.

      For documentation on the Beta release, and more examples, see the Couchbase Shell Documentation.

      IDE Plugins

      For more information about IDE plugins, see the Third Party Integrations page.