cblite-cli-macos v1.1.1

cblite Tool Documentation

cblite is a command-line tool for inspecting and querying LiteCore and Couchbase Lite databases (which are directories with a .cblite2 extension.)

It has the following sub-commands:

Interactive Mode

The tool has an interactive mode that you start by running cblite /path/to/database, i.e. with no subcommand. It will then prompt you for commands: each command is a command line without the initial cblite or the database-path parameter. Enter quit or press Ctrl-D to exit.

When starting interactive mode, you can put a few flags before the database path:

These flags were added after version 2.1.

Global Flags

These flags go immediately after cblite. No subcommand should be given.

Sub-Commands

(You can run cblite --help to get a quick summary, or cblite help CMD for help on CMD.)

cat

Displays the JSON body of a document (or of documents whose IDs match a pattern.)

cblite cat flags databasepath DOCID DOCID ...

cat flags DOCID DOCID ...

(DOCID may contain shell-style wildcards *, ?)

cp (aka export, import, push, pull)

Copies a database, imports or exports JSON, or replicates.

cblite cp flags source destination

source and destination can be database paths, replication URLs, or JSON file paths. One of them must be a database path ending in *.cblite2. The other can be any of the following:

• *.cblite2 ⟶ Copies local db file, and assigns new UUID to target *
• blip://* ⟶ Networked replication
• *.json ⟶ Imports/exports JSON file (one document per line)
• */ ⟶ Imports/exports directory of JSON files (one per doc)

* The --replicate flag can be used to force a local-to-local copy to use the replicator. If the command is invoked as push or pull, this flag is implicitly set.

cp flags destination

In interactive mode, the database path is already known, so it's used as the source, and cp takes only a destination argument. You can optionally call the command push or export. Or if you use the synonyms pull or import in interactive mode, the parameter you give is treated as the source, while the current database is the destination.

** --jsonid works as follows: When source is JSON, this is a property name/path whose value will be used as the document ID. (If omitted, documents are given UUIDs.) When destination is JSON, this is a property name that will be added to the JSON, whose value is the document's ID. (If this flag is omitted, the value defaults to _id.)

file

Shows information about the database, such as the number of documents and the latest sequence number.

cblite file databasepath

file databasepath

help

Displays a list of all commands, or details of a given command.

cblite help subcommand

help subcommand

ls

Lists the IDs of documents in the database.

cblite ls flags databasepath PATTERN

ls flags PATTERN

(PATTERN is an optional pattern for matching docIDs, with shell-style wildcards *, ?)

put

Creates or updates a document.

This command was added after version 2.1.

cblite put flags databasepath DOCID "JSON"

put flags DOCID "JSON"

The document body JSON must be a single argument; put quotes around it to ensure that and to avoid misinterpretation of special characters. JSON5 syntax is allowed.

NOTE: In the interactive mode, this command will fail unless cblite was invoked with the --writeable or --create flag.

query

Queries the database.

cblite query flags databasepath "query"

query flags "query"

The query must follow the JSON query schema. It can be a dictionary {{ ... }) containing an entire query specification, or an array ([ ... ]) with just a WHERE clause. There are examples of each up above.

The query must be a single argument; put quotes around it to ensure that and to avoid misinterpretation of special characters. JSON5 syntax is allowed.

revs

Displays the revision history of a document.

cblite revs databasepath DOCID

revs DOCID

rm

This command was added after version 2.1.

Deletes a document.

cblite rm databasepath DOCID

rm DOCID

NOTE: In the interactive mode, this command will fail unless cblite was invoked with the --writeable or --create flag.

serve

Runs a mini HTTP server that responds to the Couchbase Lite REST API.

cblite serve flags databasepath

serve flags

Note: Only a subset of the Couchbase Lite REST API is implemented so far! See the documentation.

Example

$  cblite file travel-sample.cblite2
Database:   travel-sample.cblite2/
Total size: 34MB
Documents:  31591, last sequence 31591

$  cblite ls -l --limit 10 travel-sample.cblite2
Document ID     Rev ID     Flags   Seq     Size
airline_10      1-d70614ae ---       1     0.1K
airline_10123   1-091f80f6 ---       2     0.1K
airline_10226   1-928c43f4 ---       3     0.1K
airline_10642   1-5cb6252c ---       4     0.1K
airline_10748   1-630b0443 ---       5     0.1K
airline_10765   1-e7999661 ---       6     0.1K
airline_109     1-bd546abb ---       7     0.1K
airline_112     1-ca955c69 ---       8     0.1K
airline_1191    1-28dbba6e ---       9     0.1K
airline_1203    1-045b6947 ---      10     0.1K
(Stopping after 10 docs)

$  cblite travel-sample.cblite2
(cblite) query --limit 10 '["=", [".type"], "airline"]'
["_id": "airline_10"]
["_id": "airline_10123"]
["_id": "airline_10226"]
["_id": "airline_10642"]
["_id": "airline_10748"]
["_id": "airline_10765"]
["_id": "airline_109"]
["_id": "airline_112"]
["_id": "airline_1191"]
["_id": "airline_1203"]
(Limit was 10 rows)
(cblite) query --limit 10 '{WHAT: [[".name"]], WHERE:  ["=", [".type"], "airline"], ORDER_BY: [[".name"]]}'
["40-Mile Air"]
["AD Aviation"]
["ATA Airlines"]
["Access Air"]
["Aigle Azur"]
["Air Austral"]
["Air Caledonie International"]
["Air Caraïbes"]
["Air Cargo Carriers"]
["Air Cudlua"]
(Limit was 10 rows)
(cblite) ^D
$