Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
91 lines (68 sloc) 2.55 KB


Couchpenter is CouchDB database and document setup tool.


npm install -g couchpenter 


Create setup file example:

couchpenter init

Execute a command against a CouchDB URL with specific Couchpenter configuration file:

couchpenter <target> -u http://user:pass@localhost:5984 -f couchpenter.json


setupCreate databases, then create/update documents.
teardownDelete databases.
setup-dbCreate databases only.
setup-docCreate documents only.
teardown-dbLike teardown, delete databases.
teardown-docDelete documents only.


var couchpenter = new require('couchpenter').Couchpenter(
couchpenter.setUp(function (err) {
  // handle error


Couchpenter setup file is a just a simple JSON file containing:

  "db1": [
    { "_id": "doc1", "foo": "bar" },
    { "_id": "doc2", "foo": "bar" },
  "db2": [
    { "_id": "doc4", "foo": "bar" },
  "db3": [],
  "_replicator": {
      "_id": "db1_pull",
      "source": "http://user:pass@remotehost:5984/db1",
      "target": "db1",
      "user_ctx": {
        "name": "user",
        "roles": ["_admin"]
      "continuous": true,
      "max_replication_retry_count": "infinity"

Property keys are the names of the databases that should exist in CouchDB. If a database does not exist, it will then be created.

Property values are the documents that should exist in each database. If the document does not exist, it will then be created. If it already exists, it will then be updated.

A document can be represented as:

  • an object
  • a file path string containing a JSON document, file name must end with .json
  • a module path string

Paths are relative to current directory if it's used from command-line, or relative to setUp's dir (process.cwd() in the usage example further above) if it's used programmatically.


Follow @cliffano on Twitter.

Jump to Line
Something went wrong with that request. Please try again.