Skip to content
No description or website provided.
Find file
Latest commit 5a68dab @pxlpnk pxlpnk fixing a typo
Failed to load latest commit information.
bin public release
lib public release
test public release
.gitignore public release
.jshintrc public release
LICENSE.txt public release fixing a typo
package.json public release

Contentful to CouchDB synchronization

Utility to keep in sync a CouchDB database with a Contentful space.


Contentful is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit & manage content in the cloud and publish it anywhere via powerful API. Contentful offers tools for managing editorial teams and enabling cooperation.

CouchDB is a database that completely embraces the web. Store your data with JSON documents. Access your documents and query your indexes with your web browser, via HTTP. Index, combine, and transform your documents with JavaScript.

Synchronizing Contentful spaces into CouchDB can be seen as a way to just simply backup data from Contentful to CouchDB or as a way to seed and distribute content via CouchDB replication.


This project is at proof of concept stage and is built on a best effort kind of approach without strict guarantees of correctness.


Create a JSON configuration file as follows with the data of the Contentful space that you want to synchronize from and the destination CouchDB database.

  "couch": {
    "url": "http://localhost:5984",
    "database": "sync_test"
  "verbose": true,
  "contentful": {
    "accessToken": "b4c0n73n7fu1",
    "space": "cfexampleapi"

Launch the command

contentful2couch -c config.json

The script will output some information like

processing sync response
processed 14 items

And terminate. Sucessive run of the same configuration file will process only actual changes.


Copyright (c) 2014 Contentful GmbH - Paolo Negri. See LICENSE.txt for further details.

Something went wrong with that request. Please try again.