cdb-cli v1.1.2

cdb-cli

Command line tool for interacting with CouchDB

Table of contents

• Getting started
  • Installation
  • Configuration
• Database functions
  • Create database
  • Delete database
  • Get database info
  • Get all databases
  • Replicate database
• Document functions
  • Insert document
  • Delete document
  • Read document
  • Update document
• Miscellaneous functions
  • Help
  • Version

Getting started

Installation

npm i -g cdb-cli

Configuration

Upon installation a default URL, default credentials, and default database will be set for you.

The URL is set to http://localhost:5984,the credentials are set to admin:pass, and the database is set to an empty string (meaning that no default database is set).

You can edit them with the following commands:

cdb set --url http://mycustomurl.com/
cdb set --auth username:password
cdb set --database example

# setting multiple defaults at the same time
cdb set --url http://mycustomurl.com --auth username:password

Setting a default database will allow you to omit the database argument in all of the document functions, although you can still provide it if you want.

Database functions

Create database

database - the name of the database

cdb create database

Delete database

database - the name of the database

cdb destroy database

Get database info

database - the name of the database

cdb info database

Get all databases

cdb all

Replicate database

source - the name of the database to be replicated

target - the name of the database to replicate to

If the target database does not exist then it will be created before replicating.

cdb replicate source target

Document functions

Insert document

database - the name of the database

document - the document as a JSON string or the relative path to the JSON document

cdb insert database document

Delete document

database - the name of the database

document - the ID of the document

cdb delete database document

Read document

database - the name of the database

document - the ID of the document

cdb read database document

Update document

database - the name of the database

document - the updated document

cdb update database document

Miscellaneous functions

Help

# any of these will work
cdb help
cdb --help
cdb -h

Version

# any of these will work
cdb version
cdb --version
cdb -v