Edit on GitHub
Platform: iOS Android WPF

You will install Couchbase Lite using the PhoneGap CLI module.

npm install -g phonegap
phonegap create UntitledApp
cd UntitledApp/
phonegap local plugin add

On iOS, you must have the ios-sim module installed globally to start the emulator from the command line.

npm install -g ios-sim
phonegap run ios

Getting Started

Open www/js/index.js and add the following in the onDeviceReady lifecycle method.

if (window.cblite) {
  window.cblite.getURL(function (err, url) {
    if (err) {
      app.logMessage("error launching Couchbase Lite: " + err)
    } else {
      app.logMessage("Couchbase Lite running at " + url);
} else {
  app.logMessage("error, Couchbase Lite plugin not found.")

Below the onDeviceReady method, add a new method called logMessage.

logMessage: function(message) {
  var p = document.createElement("p");
  p.innerHTML = message;

Build & run.

phonegap run ios
phonegap run android

The Couchbase Lite endpoint is displayed on the screen and you can start making RESTful queries to it using the HTTP library of your choice.

Listener API

The Couchbase Lite Listener exposes the same functionality as the native SDKs through a common RESTful API. You can perform the same operations on the database by sending HTTP requests to it.

The Swagger JS client allows us to leverage the Couchbase Lite REST API Swagger spec in hybrid mobile frameworks such as PhoneGap. To install the Swagger JS library in your project do the following:

  window.spec = {
    "swagger": "2.0",
    "info": {
      "title": "Couchbase Lite",

Here, you're embedding the API spec as part of the application so that the JS library can also work offline.

Reference both files in www/index.html before app.initialize() is executed.

<script type="text/javascript" src="js/swagger-client.min.js"></script>
<script type="text/javascript" src="js/spec.js"></script>
<script type="text/javascript">

Then, open www/js/index.js and add the following in the onDeviceReady lifecycle method.

var client = new SwaggerClient({
  spec: window.spec,
  usePromise: true,
  .then(function (client) {
      .then(function (res) {
        var dbs = res.obj;
        if (dbs.indexOf('todo') == -1) {
          return client.database.put_db({db: 'todo'});
        return client.database.get_db({db: 'todo'});
      .then(function (res) {
        return{db: 'todo', body: {task: 'Groceries'}});
      .then(function (res) {
        return client.query.get_db_all_docs({db: 'todo'});
      .then(function (res) {
        alert(res.obj.rows.length + ' document(s) in the database');
      .catch(function (err) {

First you set the host of the Swagger JS client to the url provided in the callback (it is of the form lite.couchbase. on iOS and localhost:5984 on Android). The chain of promises creates the database, inserts a document and displays the total number of documents in an alert window using the /{db}/_all_docs endpoint.

Build and run.

phonegap run ios
phonegap run android

You should see the alert dialog displaying the number of documents.