index.html

---
layout: default
excerpt: Kivik provides a common CouchDB and PouchDB API for Golang and GopherJS.
---

<link rel="stylesheet" href="/css/highlight.css">
<script src="/js/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>

<div class="header-container jumbotron">
    <div class="container">
        <div class="col-md-6">
            <h1>CouchDB and PouchDB library for Go</h1>
            <p>Kivik provides a common Go and GopherJS client library for
                CouchDB, PouchDB, and similar databases.
            </p>
            <p><a class="btn btn-primary btn-lg" href="#more" role="button">Learn more</a></p>
        </div>
        <div class="col-md-6">
            <pre><code class="go">package main

import "context"
import "github.com/go-kivik/kivik/v3"
import _ "github.com/go-kivik/couchdb/v3" // The CouchDB driver

func main() {
    dsn := "http://localhost:5984"
    client, err := kivik.New(context.TODO(), "couch", dsn)
    if err != nil {
        panic(err)
    }
    // ...
}</code></pre>
        </div>
    </div>
</div>

<div class="container">

    <div class="row">
        <div class="col-md-6">
            <a id="more"></a>
            <h2 class="header-light regular-pad">What is Kivik?</h2>
            <p>
                Kivik is a common interface to CouchDB and CouchDB-like databases
                for Go and GopherJS.
            </p>
            <p>
                Kivik's driver architecture is modeled after the Go standard
                library's <a href="https://golang.org/pkg/database/sql/">sql</a>
                and <a href="https://golang.org/pkg/database/sql/driver/">sql/driver</a>
                packages.  This allows for the addition of
                <a href="https://github.com/go-kivik/kivik/wiki/Kivik-database-drivers">arbitrary
                backend drivers</a>, while maintaining API compatibility.
            </p>
            <p>
                A primary goal of Kivik is to provide a common interface to
                both CouchDB in Go, and PouchDB in
                <a href="https://github.com/gopherjs/gopherjs">GopherJS</a>.
            </p>
            <p>
                Install Kivik and the CouchDB driver to get started:
            </p>
            <pre>
    go get -u github.com/go-kivik/kivik/v3
    go get -u github.com/go-kivik/couchdb/v3</pre>
            <p>
                Then follow the <a href="https://github.com/go-kivik/kivik/wiki/Usage-Examples">Usage
                Examples</a>, or read the <a href="https://pkg.go.dev/github.com/go-kivik/kivik/v3">GoDoc</a>,
                or visit the project page on <a href="https://github.com/go-kivik/kivik">GitHub</a>.
            </p>
        </div>
        <div class="col-md-6 text-center">
            <img src="img/logo-kivik.png" alt="Kivik logo" class="img-responsive">
        </div>
    </div>
    <hr>

    <div class="row">
        <div class="col-md-6">
            <a id="more"></a>
            <h2 class="header-light regular-pad">Community</h2>
            <p>
                Kivik is primarily developed by
                <a href="https://github.com/flimzy">Jonathan Hall</a>, but
                <a href="https://github.com/go-kivik/kivik/graphs/contributors">many
                others</a> have contributed.
            <p>
            <p>
                We have recently created the
                <a href="https://gophers.slack.com/messages/kivik">#kivik channel
                on Gophers Slack</a> (invites <a href="https://invite.slack.golangbridge.org/">here</a>). Come join the discussion!
            <p>
        </div>
        <div class="col-md-6 text-center">
            <img src="img/logo-kivik.png" alt="Kivik logo" class="img-responsive">
        </div>
    </div>
    <hr>

    <div class="row">
        <div class="col-sm-3">
            <h1 class="text-center"><img class="logo" src="/img/logo-golang.svg" alt="Golang logo"></h1>
            <h3 class="text-center">Go</h3>
            <p>Kivik is tested against all versions of <a href="https://golang.org/">Go</a>
                from 1.7.
            </p>
        </div>
        <div class="col-sm-3">
            <h1 class="text-center"><img class="logo" src="/img/logo-couchdb.svg" alt="CouchDB logo"></h1>
            <h3 class="text-center">CouchDB</h3>
            <p>Kivik's <a href="https://github.com/go-kivik/couchdb">couchdb driver</a>
               works with all stable releases of <a href="http://couchdb.apache.org/">CouchDB</a>
               from 1.6.1.
        </p>
        </div>
        <div class="col-sm-3">
            <h1 class="text-center"><img class="logo" src="/img/logo-gopherjs.svg" alt="GopherJS logo"></h1>
            <h3 class="text-center">GopherJS</h3>
            <p>Kivik works with the latest release of <a href="https://github.com/gopherjs/gopherjs">GopherJS</a>.
            </p>
        </div>
        <div class="col-sm-3">
            <h1 class="text-center"><img class="logo" src="/img/logo-pouchdb.svg" alt="PouchDB logo"></h1>
            <h3 class="text-center">PouchDB</h3>
            <p>Kivik's <a href="https://github.com/go-kivik/pouchdb">pouchdb driver</a>
                works with all stable versions of <a href="https://pouchdb.com/">PouchDB</a>
                from 6.0.0, when built using <a href="https://github.com/gopherjs/gopherjs">GopherJS</a>.
            </p>
        </div>
    </div>

</div>