Name Date Size

..19-Aug-20204 KiB

.gitignoreH A D19-Aug-2020428

cb_bin_client.pyH A D19-Aug-202020.8 KiB

cb_util.pyH A D19-Aug-2020153

cb_version.cmake.pyH A D19-Aug-202031

cbbackupH A D19-Aug-2020205

cbbackupwrapperH A D19-Aug-202014 KiB

cblogredactionH A D19-Aug-20206.8 KiB

cbmgr.pyH A D19-Aug-2020224.3 KiB

cbrecoveryH A D19-Aug-20207.9 KiB

cbrestoreH A D19-Aug-2020207

cbrestorewrapperH A D19-Aug-202013.1 KiB

cbtransferH A D19-Aug-2020919

cbworkloadgenH A D19-Aug-20207 KiB

cluster_manager.pyH A D19-Aug-202080.8 KiB

CMakeLists.txtH A D19-Aug-20201.4 KiB

couchbase-cliH A D19-Aug-2020345

couchbaseConstants.pyH A D19-Aug-20207.5 KiB

docs/H19-Aug-20204 KiB

LICENSEH A D19-Aug-202011.1 KiB

pbar.pyH A D19-Aug-20207.3 KiB

pump.pyH A D19-Aug-202047.6 KiB

pump_bfd.pyH A D19-Aug-202038.4 KiB

pump_bfd2.pyH A D19-Aug-20201.6 KiB

pump_cb.pyH A D19-Aug-202020.9 KiB

pump_csv.pyH A D19-Aug-202010.4 KiB

pump_dcp.pyH A D19-Aug-202036.9 KiB

pump_gen.pyH A D19-Aug-20208.3 KiB

pump_json.pyH A D19-Aug-20207.1 KiB

pump_mc.pyH A D19-Aug-202029.8 KiB

pump_sfd.pyH A D19-Aug-202021.2 KiB

pump_transfer.pyH A D19-Aug-202020.1 KiB

README.adocH A D19-Aug-20201.7 KiB

requests/H19-Aug-20204 KiB

t/H19-Aug-20204 KiB

test/H19-Aug-20204 KiB

README.adoc

1= Couchbase Command Line Tools
2
3This package contains the command line tool set that performs the same
4actions to provide the user the same capabilities as the Couchbase
5Server web interface.
6
7== Prerequisites
8
9If you have installed the full Couchbase Server, these tools will have
10all prerequisites required to run these tools. If you run these tools
11standalone, you will need:
12
13* Python 3.3 or greater
14* Command shell such as bash
15
16== Building the Documentation
17
18The documentation for this tool set is stored in link:docs[]. The source
19documents, which can be found in link:docs/modules/cli/pages/cbcli[], are
20written in AsciiDoc and used to produce HTML and man page files.
21
22NOTE: The docs folder structure is deeply nested in order for these documents to be
23incorporated directly into the main documentation for Couchbase Server hosted
24at https://docs.couchbase.com.
25
26You can use the link:docs/generate.sh[generate.sh] script to generate
27standalone HTML and man page versions of these source documents. The list of
28files to convert is maintained in the script itself. When run, the script
29writes the generated documents to the link:docs/generated[generated] folder.
30Under the current workflow, this folder needs to be committed back to the
31repository for other tools to consume.
32
33The generate.sh script requires the *asciidoctor* command to be available on
34your machine (which in turn requires Ruby). Installation of this software is
35covered in the next section.
36
37== Running unit test
38
39To run the unit tests use the following command from the `couchbase-cli` directory.
40
41  $ python -m unittest discover -s ./test
42
43
44=== macOS Requirements
45
46 $ brew install asciidoctor
47
48---
49
50Copyright (C) 2018 Couchbase, Inc.
51