Table of Contents
=================

* [rlx(1) cheatsheet](#rlx1-cheatsheet)
  * [Server](#server)
    * [GET /](#get-)
    * [GET /_active_tasks](#get-_active_tasks)
    * [GET /_log](#get-_log)
    * [GET /_log](#get-_log-1)
    * [POST /_restart](#post-_restart)
    * [GET /_stats](#get-_stats)
    * [GET /_uuids](#get-_uuids)
  * [Database](#database)
    * [PUT /{db}](#put-db)
    * [POST /{db}/_bulk_docs](#post-db_bulk_docs)
    * [GET /_all_dbs](#get-_all_dbs)
    * [POST /{db}/_temp_view](#post-db_temp_view)
    * [POST /{db}/_purge](#post-db_purge)
    * [POST /{db}/_missing_revs](#post-db_missing_revs)
    * [POST /{db}/_revs_diff](#post-db_revs_diff)
    * [GET /{db}/_changes](#get-db_changes)
    * [POST /{db}/_view_cleanup](#post-db_view_cleanup)
    * [POST /{db}/_ensure_full_commit](#post-db_ensure_full_commit)
    * [POST /{db}/_compact](#post-db_compact)
    * [POST /{db}/_compact/{ddoc}](#post-db_compactddoc)
    * [HEAD /{db}](#head-db)
    * [GET /{db}](#get-db)
    * [GET /{db}/_revs_limit](#get-db_revs_limit)
    * [PUT /{db}/_revs_limit](#put-db_revs_limit)
    * [DELETE /{db}](#delete-db)
    * [GET /_db_updates](#get-_db_updates)
  * [Document](#document)
    * [PUT /{db}/{docid}](#put-dbdocid)
    * [COPY /{db}/{docid}](#copy-dbdocid)
    * [GET /{db}/{docid}](#get-dbdocid)
    * [GET /{db}/{docid}?conflicts=true](#get-dbdocidconflictstrue)
    * [GET /{db}/{docid}?deleted_conflicts=true](#get-dbdociddeleted_conflictstrue)
    * [GET /{db}/{docid}?revs=true](#get-dbdocidrevstrue)
    * [GET /{db}/{docid}?revsinfo=true](#get-dbdocidrevsinfotrue)
    * [GET /{db}/{docid}?meta=true](#get-dbdocidmetatrue)
    * [GET /{db}/_all_docs](#get-db_all_docs)
    * [HEAD /{db}/{docid}](#head-dbdocid)
    * [DELETE /{db}/{docid}](#delete-dbdocid)
  * [Design Document](#design-document)
    * [PUT /{db}/_design/{ddoc}](#put-db_designddoc)
    * [GET /{db}/_all_docs](#get-db_all_docs-1)
    * [COPY /{db}/_design/{ddoc}](#copy-db_designddoc)
    * [GET /{db}/_design/{ddoc}](#get-db_designddoc)
    * [HEAD /{db}/_design/{ddoc}](#head-db_designddoc)
    * [GET /{db}/_design/{ddoc}/_info](#get-db_designddoc_info)
    * [PUT /{db}/_design/{ddoc}/{attname}](#put-db_designddocattname)
    * [GET /{db}/_design/{ddoc}/{attname}](#get-db_designddocattname)
    * [HEAD /{db}/_design/{ddoc}/{attname}](#head-db_designddocattname)
    * [GET /{db}/{docid}](#get-dbdocid-1)
    * [DELETE /{db}/_design/{ddoc}/{attname}](#delete-db_designddocattname)
    * [GET /{db}/_design/{ddoc}/_view/{view}](#get-db_designddoc_viewview)
    * [POST /{db}/_design/{ddoc}/_update/{func}](#post-db_designddoc_updatefunc)
    * [PUT /{db}/_design/{ddoc}/_update/{func}](#put-db_designddoc_updatefunc)
    * [POST /{db}/_design/{ddoc}/_show/{func}](#post-db_designddoc_showfunc)
    * [POST /{db}/_design/{ddoc}/_show/{func}/{docid}](#post-db_designddoc_showfuncdocid)
    * [GET /{db}/_design/{ddoc}/_list/{func}/{view}](#get-db_designddoc_listfuncview)
    * [GET /{db}/_design/{ddoc}/_list/{func}/{ddoc}/{view}](#get-db_designddoc_listfuncddocview)
    * [ANY /{db}/_design/{ddoc}/_rewrite/{path}](#any-db_designddoc_rewritepath)
    * [COPY /{db}/_design/{ddoc}](#copy-db_designddoc-1)
    * [DELETE /{db}/_design/{ddoc}](#delete-db_designddoc)
  * [Attachment](#attachment)
    * [GET /{db}/{docid}](#get-dbdocid-2)
    * [PUT /{db}/{docid}/{attname}](#put-dbdocidattname)
    * [GET /{db}/{docid}/{attname}](#get-dbdocidattname)
    * [HEAD /{db}/{docid}/{attname}](#head-dbdocidattname)
    * [GET /{db}/{docid}](#get-dbdocid-3)
    * [DELETE /{db}/{docid}/{attname}](#delete-dbdocidattname)
    * [GET /{db}/{docid}](#get-dbdocid-4)
  * [Administrator](#administrator)
    * [GET /_config/admins](#get-_configadmins)
    * [PUT /_config/admins/{key}](#put-_configadminskey)
    * [GET /_config/admins/{key}](#get-_configadminskey)
    * [DELETE /_config/admins/{key}](#delete-_configadminskey)
  * [User](#user)
    * [GET /_users/_all_docs](#get-_users_all_docs)
    * [PUT /_users/{docid}](#put-_usersdocid)
    * [GET /_users/{docid}](#get-_usersdocid)
    * [DELETE /_users/{docid}](#delete-_usersdocid)
  * [Security](#security)
    * [GET /{db}/_security](#get-db_security)
    * [PUT /{db}/_security](#put-db_security)
  * [Session](#session)
    * [POST /{db}/_session](#post-db_session)
    * [GET /{db}/_session](#get-db_session)
    * [DELETE /{db}/_session](#delete-db_session)
  * [Replicate](#replicate)
    * [GET /_active_tasks](#get-_active_tasks-1)
    * [POST /_replicate](#post-_replicate)
    * [POST /_replicate](#post-_replicate-1)
  * [Local Document](#local-document)
    * [PUT /{db}/_local/{docid}](#put-db_localdocid)
    * [COPY /{db}/_local/{docid}](#copy-db_localdocid)
    * [GET /{db}/_local/{docid}](#get-db_localdocid)
    * [DELETE /{db}/_local/{docid}](#delete-db_localdocid)
  * [Configuration](#configuration)
    * [PUT /_config/{section}/{key}](#put-_configsectionkey)
    * [GET /_config](#get-_config)
    * [GET /_config/{section}](#get-_configsection)
    * [GET /_config/{section}/{key}](#get-_configsectionkey)
    * [DELETE /_config/{section}/{key}](#delete-_configsectionkey)
  * [Log Level](#log-level)
    * [PUT /_config/log/level](#put-_configloglevel)
    * [GET /_config/log/level](#get-_configloglevel)

rlx(1) cheatsheet
=================

API methods yet to be implemented are marked with a strikethrough.

## Server

* Manual: `rlx help`
* Help: `rlx --help`

### GET /

Get server meta information:

```
rlx info -s {server}
```

Documentation: [server/common#get](http://docs.couchdb.org/en/latest/api/server/common.html#get--)

### GET /_active_tasks

Get active tasks:

```
rlx tasks -s {server}
```

Documentation: [server/common#get-active-tasks](http://docs.couchdb.org/en/latest/api/server/common.html#get--_active_tasks)

### GET /_log

Tail log file:

```
rlx log -s {server}
```

Documentation: [server/common#get-log](http://docs.couchdb.org/en/latest/api/server/common.html#get--_log)

### GET /_log

Tail raw log file:

```
rlx log --raw -s {server}
```

Documentation: [server/common#get-log](http://docs.couchdb.org/en/latest/api/server/common.html#get--_log)

### POST /_restart

Restart the server:

```
rlx restart -s {server}
```

Documentation: [server/common#post-restart](http://docs.couchdb.org/en/latest/api/server/common.html#post--_restart)

### GET /_stats

Get server statistics:

```
rlx stats -s {server}
```

Documentation: [server/common#get-stats](http://docs.couchdb.org/en/latest/api/server/common.html#get--_stats)

### GET /_uuids

Get uuids:

```
rlx uuids -s {server}
```

Documentation: [server/common#get-uuids](http://docs.couchdb.org/en/latest/api/server/common.html#get--_uuids)

## Database

* Manual: `rlx help db`
* Help: `rlx --help db`

### PUT /{db}

Create a database:

```
rlx db add -s {server} -d {db}
```

Documentation: [database/common#put-db](http://docs.couchdb.org/en/latest/api/database/common.html#put--db)

### POST /{db}/_bulk_docs

Bulk insert/update:

```
rlx db bulk -s {server} -d {db} @docs={docid},bar
```

Documentation: [database/bulk-api#post-db-bulk-docs](http://docs.couchdb.org/en/latest/api/database/bulk-api.html#post--db-_bulk_docs)

### GET /_all_dbs

List databases:

```
rlx db ls -s {server}
```

Documentation: [server/common#all-dbs](http://docs.couchdb.org/en/latest/api/server/common.html#all-dbs)

### POST /{db}/_temp_view

Execute a temporary view:

```
rlx db temp -s {server} -d {db}
```

Documentation: [database/temp-views#post-db-temp-view](http://docs.couchdb.org/en/latest/api/database/temp-views.html#post--db-_temp_view)

### POST /{db}/_purge

Purge documents:

```
rlx db purge -s {server} -d {db} @{docid}=1-0
```

Documentation: [database/misc#post-db-purge](http://docs.couchdb.org/en/latest/api/database/misc.html#post--db-_purge)

### POST /{db}/_missing_revs

Find document revisions that do not exist:

```
rlx db mrevs -s {server} -d {db} @{docid}=1-0
```

Documentation: [database/misc#post-db-missing-revs](http://docs.couchdb.org/en/latest/api/database/misc.html#post--db-_missing_revs)

### POST /{db}/_revs_diff

Get document revision diff:

```
rlx db rdiff -s {server} -d {db} @{docid}=1-0
```

Documentation: [database/misc#post-db-revs-diff](http://docs.couchdb.org/en/latest/api/database/misc.html#post--db-_revs_diff)

### GET /{db}/_changes

Get database changes:

```
rlx db changes -s {server} -d {db}
```

Documentation: [database/changes#get-db-changes](http://docs.couchdb.org/en/latest/api/database/changes.html#get--db-_changes)

### POST /{db}/_view_cleanup

Clean view indices:

```
rlx db cleanup -s {server} -d {db}
```

Documentation: [database/compact#post-db-view-cleanup](http://docs.couchdb.org/en/latest/api/database/compact.html#post--db-_view_cleanup)

### POST /{db}/_ensure_full_commit

Ensure full commit:

```
rlx db commit -s {server} -d {db}
```

Documentation: [database/compact#post-db-ensure-full-commit](http://docs.couchdb.org/en/latest/api/database/compact.html#post--db-_ensure_full_commit)

### POST /{db}/_compact

Compact database:

```
rlx db compact -s {server} -d {db}
```

Documentation: [database/compact#post-db-compact](http://docs.couchdb.org/en/latest/api/database/compact.html#post--db-_compact)

### POST /{db}/_compact/{ddoc}

Compact database design document:

```
rlx db compact -s {server} -d {db} --ddoc {ddoc}
```

Documentation: [database/compact#post-db-compact-ddoc](http://docs.couchdb.org/en/latest/api/database/compact.html#post--db-_compact-ddoc)

### HEAD /{db}

Check database existence:

```
rlx db head -s {server} -d {db}
```

Documentation: [database/common#head-db](http://docs.couchdb.org/en/latest/api/database/common.html#head--db)

### GET /{db}

Get database meta information:

```
rlx db info -s {server} -d {db}
```

Documentation: [database/common#get-db](http://docs.couchdb.org/en/latest/api/database/common.html#get--db)

### GET /{db}/_revs_limit

Get database revisions limit:

```
rlx db limit -s {server} -d {db}
```

Documentation: [database/misc#get-db-revs-limit](http://docs.couchdb.org/en/latest/api/database/misc.html#get--db-_revs_limit)

### PUT /{db}/_revs_limit

Set database revisions limit:

```
rlx db limit -s {server} -d {db} 1000
```

Documentation: [database/misc#put-db-revs-limit](http://docs.couchdb.org/en/latest/api/database/misc.html#put--db-_revs_limit)

### DELETE /{db}

Remove database:

```
rlx db rm -s {server} {db}
```

Documentation: [database/common#delete-db](http://docs.couchdb.org/en/latest/api/database/common.html#delete--db)

### GET /_db_updates

Get database updates:

```
rlx db updates -s {server} --feed longpoll
```

Documentation: [server/common#get-db-updates](http://docs.couchdb.org/en/latest/api/server/common.html#get--_db_updates)

## Document

* Manual: `rlx help doc`
* Help: `rlx --help doc`

### PUT /{db}/{docid}

Create a document:

```
rlx doc add -s {server} -d {db} -t {template} -i {docid} @bool=false @int=1024 @float=1.67 @arr=1,2,3 @str=value @nil=null
```

Documentation: [document/common#put-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#put--db-docid)

### COPY /{db}/{docid}

Copy a document:

```
rlx doc cp -s {server} -d {db} -i {docid} --destination {docid}
```

Documentation: [document/common#copy-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#copy--db-docid)

### GET /{db}/{docid}

Get a document:

```
rlx doc get -s {server} -d {db} -i {docid}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

### GET /{db}/{docid}?conflicts=true

Get a document with conflicts:

```
rlx doc conflicts -s {server} -d {db} -i {docid}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

### GET /{db}/{docid}?deleted_conflicts=true

Get a document with deleted conflicts:

```
rlx doc dc -s {server} -d {db} -i {docid}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

### GET /{db}/{docid}?revs=true

Get a document with revisions:

```
rlx doc revs -s {server} -d {db} -i {docid}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

### GET /{db}/{docid}?revsinfo=true

Get a document with revision information:

```
rlx doc revsinfo -s {server} -d {db} -i {docid}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

### GET /{db}/{docid}?meta=true

Get a document with meta information:

```
rlx doc meta -s {server} -d {db} -i {docid}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

### GET /{db}/_all_docs

List documents:

```
rlx doc ls -s {server} -d {db}
```

Documentation: [database/bulk-api#get-db-all-docs](http://docs.couchdb.org/en/latest/api/database/bulk-api.html#get--db-_all_docs)

### HEAD /{db}/{docid}

Get document revision:

```
rlx doc head -s {server} -d {db} -i {docid}
rlx doc rev -s {server} -d {db} -i {docid}
```

Documentation: [document/common#head-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#head--db-docid)

### DELETE /{db}/{docid}

Remove a document:

```
rlx doc rm -s {server} -d {db} -i {docid}
```

Documentation: [document/common#delete-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#delete--db-docid)

## Design Document

* Manual: `rlx help app`
* Help: `rlx --help app`

### PUT /{db}/_design/{ddoc}

Push a design document:

```
rlx app push -s {server} -d {db} -i {ddoc} {dir}
rlx app push -s {server} -d {db} -i {ddoc} -t {template}
```

Documentation: [ddoc/common#put-db-design-ddoc](http://docs.couchdb.org/en/latest/api/ddoc/common.html#put--db-_design-ddoc)

### GET /{db}/_all_docs

List design documents:

```
rlx app ls -s {server} -d {db}
```

Documentation: [database/bulk-api##get-db-all-docs](http://docs.couchdb.org/en/latest/api/database/bulk-api.html##get--db-_all_docs)

### COPY /{db}/_design/{ddoc}

Copy a design document:

```
rlx app cp -s {server} -d {db} -i {ddoc} --destination {ddoc}
```

Documentation: [ddoc/common#copy-db-design-ddoc](http://docs.couchdb.org/en/latest/api/ddoc/common.html#copy--db-_design-ddoc)

### GET /{db}/_design/{ddoc}

Get a design document:

```
rlx app get -s {server} -d {db} -i {ddoc}
```

Documentation: [ddoc/common#get-db-design-ddoc](http://docs.couchdb.org/en/latest/api/ddoc/common.html#get--db-_design-ddoc)

### HEAD /{db}/_design/{ddoc}

Head a design document:

```
rlx app head -s {server} -d {db} -i {ddoc}
```

Documentation: [ddoc/common#head-db-design-ddoc](http://docs.couchdb.org/en/latest/api/ddoc/common.html#head--db-_design-ddoc)

### GET /{db}/_design/{ddoc}/_info

Get design document information:

```
rlx app info -s {server} -d {db} -i {ddoc}
```

Documentation: [ddoc/common#get-db-design-ddoc-info](http://docs.couchdb.org/en/latest/api/ddoc/common.html#get--db-_design-ddoc-_info)

### PUT /{db}/_design/{ddoc}/{attname}

Upload design document attachment:

```
rlx app att up -s {server} -d {db} --ddoc {ddoc} -a {attname} {file}
rlx app att up -s {server} -d {db} -ddoc {ddoc} {dir}
rlx app att up -s {server} -d {db} --ddoc {ddoc} --recursive {dir}
```

Documentation: [ddoc/common#put-db-design-ddoc-attname](http://docs.couchdb.org/en/latest/api/ddoc/common.html#put--db-_design-ddoc-attname)

### GET /{db}/_design/{ddoc}/{attname}

Download design document attachment(s):

```
rlx app att dl -s {server} -d {db} --ddoc {ddoc} {ptn} {dir}
rlx app att dl -s {server} -d {db} --ddoc {ddoc} **/** {dir} --force
```

Documentation: [ddoc/common#get-db-design-ddoc-attname](http://docs.couchdb.org/en/latest/api/ddoc/common.html#get--db-_design-ddoc-attname)

### HEAD /{db}/_design/{ddoc}/{attname}

Head design document attachment information:

```
rlx app att head -s {server} -d {db} --ddoc {ddoc} -a {attname}
```

Documentation: [ddoc/common#head-db-design-ddoc-attname](http://docs.couchdb.org/en/latest/api/ddoc/common.html#head--db-_design-ddoc-attname)

### GET /{db}/{docid}

Get design document attachment information:

```
rlx app att get -s {server} -d {db} --ddoc {ddoc} -a {attname}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

### DELETE /{db}/_design/{ddoc}/{attname}

Remove design document attachment:

```
rlx app att rm -s {server} -d {db} --ddoc {ddoc} -a {attname}
```

Documentation: [ddoc/common#delete-db-design-ddoc-attname](http://docs.couchdb.org/en/latest/api/ddoc/common.html#delete--db-_design-ddoc-attname)

### GET /{db}/_design/{ddoc}/_view/{view}

Query design document view:

```
rlx app view -s {server} -d {db} --ddoc {ddoc} -n {func}
rlx app view -s {server} -d {db} --ddoc {ddoc} -n {func} -q 'reduce=false&include_docs=true'
```

Documentation: [ddoc/views#get-db-design-ddoc-view-view](http://docs.couchdb.org/en/latest/api/ddoc/views.html#get--db-_design-ddoc-_view-view)

### POST /{db}/_design/{ddoc}/_update/{func}

Post to design document update function:

```
rlx app update -s {server} -d {db} --ddoc {ddoc} -n {func}
```

Documentation: [ddoc/render#post-db-design-ddoc-update-func](http://docs.couchdb.org/en/latest/api/ddoc/render.html#post--db-_design-ddoc-_update-func)

### PUT /{db}/_design/{ddoc}/_update/{func}

Put to design document update function:

```
rlx app update -s {server} -d {db} --ddoc {ddoc} -n {func} -i {docid} -f {file}
```

Documentation: [ddoc/render#put-db-design-ddoc-update-func-docid](http://docs.couchdb.org/en/latest/api/ddoc/render.html#put--db-_design-ddoc-_update-func-docid)

### POST /{db}/_design/{ddoc}/_show/{func}

Run a show function with no document:

```
rlx app show -s {server} -d {db} --ddoc {ddoc} -n {func}
```

Documentation: [ddoc/render#post-db-design-ddoc-show-func](http://docs.couchdb.org/en/latest/api/ddoc/render.html#post--db-_design-ddoc-_show-func)

### POST /{db}/_design/{ddoc}/_show/{func}/{docid}

Run a document through a show function:

```
rlx app show -s {server} -d {db} --ddoc {ddoc} -n {func} -i {docid}
```

Documentation: [ddoc/render#post-db-design-ddoc-show-func](http://docs.couchdb.org/en/latest/api/ddoc/render.html#post--db-_design-ddoc-_show-func)

### GET /{db}/_design/{ddoc}/_list/{func}/{view}

Run a list function:

```
rlx app list -s {server} -d {db} --ddoc {ddoc} -n {func} {view}
```

Documentation: [ddoc/render#get-db-design-ddoc-list-func-view](http://docs.couchdb.org/en/latest/api/ddoc/render.html#get--db-_design-ddoc-_list-func-view)

### GET /{db}/_design/{ddoc}/_list/{func}/{ddoc}/{view}

Run a list function against another design document:

```
rlx app list -s {server} -d {db} --ddoc {ddoc} -n {func} {ddoc}/{view}
```

Documentation: [ddoc/render#get-db-design-ddoc-list-func-view](http://docs.couchdb.org/en/latest/api/ddoc/render.html#get--db-_design-ddoc-_list-func-view)

### ANY /{db}/_design/{ddoc}/_rewrite/{path}

Run a rewrite rule path:

```
rlx app rewrite -s {server} -d {db} --ddoc {ddoc} {path}
```

Documentation: [ddoc/rewrites#any-db-design-ddoc-rewrite-path](http://docs.couchdb.org/en/latest/api/ddoc/rewrites.html#any--db-_design-ddoc-_rewrite-path)

### COPY /{db}/_design/{ddoc}

Deploy an application in a live environment:

```
rlx app deploy -s {server} -d {db} --ddoc {ddoc}
```

Documentation: [ddoc/common#copy-db-design-ddoc](http://docs.couchdb.org/en/latest/api/ddoc/common.html#copy--db-_design-ddoc)

### DELETE /{db}/_design/{ddoc}

Remove a design document:

```
rlx app rm -s {server} -d {db} -i {ddoc}
```

Documentation: [ddoc/common#delete-db-design-ddoc](http://docs.couchdb.org/en/latest/api/ddoc/common.html#delete--db-_design-ddoc)

## Attachment

* Manual: `rlx help att`
* Help: `rlx --help att`

### GET /{db}/{docid}

List document attachments:

```
rlx att ls -s {server} -d {db} -i {docid}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

### PUT /{db}/{docid}/{attname}

Upload attachment(s):

```
rlx att up -s {server} -d {db} -i {docid} {file}
rlx att up -s {server} -d {db} -i {docid} {dir}
rlx att up -s {server} -d {db} -i {docid} --recursive {dir}
```

Documentation: [document/attachments#put-db-docid-attname](http://docs.couchdb.org/en/latest/api/document/attachments.html#put--db-docid-attname)

### GET /{db}/{docid}/{attname}

Download attachment(s):

```
rlx att dl -s {server} -d {db} -i {docid} {ptn} {dir}
rlx att dl -s {server} -d {db} -i {docid} **/** {dir} --force
```

Documentation: [document/attachments#get-db-docid-attname](http://docs.couchdb.org/en/latest/api/document/attachments.html#get--db-docid-attname)

### HEAD /{db}/{docid}/{attname}

Head attachment information:

```
rlx att head -s {server} -d {db} -i {docid} -a {attname}
```

Documentation: [document/attachments#head-db-docid-attname](http://docs.couchdb.org/en/latest/api/document/attachments.html#head--db-docid-attname)

### GET /{db}/{docid}

Get attachment information:

```
rlx att get -s {server} -d {db} -i {docid} -a {attname}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

### DELETE /{db}/{docid}/{attname}

Remove an attachment:

```
rlx att rm -s {server} -d {db} -i {docid} -a {attname}
```

Documentation: [document/attachments#delete-db-docid-attname](http://docs.couchdb.org/en/latest/api/document/attachments.html#delete--db-docid-attname)

### GET /{db}/{docid}

List design document attachments:

```
rlx att ls -s {server} -d {db} --ddoc {ddoc}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

## Administrator

* Manual: `rlx help admin`
* Help: `rlx --help admin`

### GET /_config/admins

List administrators:

```
rlx admin ls -s {server}
rlx admin ls -s {server} -u {username} -p {password}
```

Documentation: [server/configuration#get-config-section](http://docs.couchdb.org/en/latest/api/server/configuration.html#get--_config-section)

### PUT /_config/admins/{key}

Add an administrator:

```
rlx admin add {username} {password} -s {server}
```

Documentation: [server/configuration#put-config-section-key](http://docs.couchdb.org/en/latest/api/server/configuration.html#put--_config-section-key)

### GET /_config/admins/{key}

Get an administrator:

```
rlx admin get {username} -u {username} -p {password} -s {server}
```

Documentation: [server/configuration#get-config-section-key](http://docs.couchdb.org/en/latest/api/server/configuration.html#get--_config-section-key)

### DELETE /_config/admins/{key}

Remove an administrator:

```
rlx admin rm {username} -u {username} -p {password} -s {server}
```

Documentation: [server/configuration#delete-config-section-key](http://docs.couchdb.org/en/latest/api/server/configuration.html#delete--_config-section-key)

## User

* Manual: `rlx help user`
* Help: `rlx --help user`

### GET /_users/_all_docs

List users:

```
rlx user -s {server}
rlx user ls -s {server}
```

Documentation: [database/bulk-api#get-db-all-docs](http://docs.couchdb.org/en/latest/api/database/bulk-api.html#get--db-_all_docs)

### PUT /_users/{docid}

Create or update a user:

```
rlx user add -s {server} @name={username} @password={password} @roles=user
rlx user edit -s {server} @name={username}
rlx user passwd -s {server} @name={username} @password={password}
```

Documentation: [document/common#put-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#put--db-docid)

### GET /_users/{docid}

Get a user:

```
rlx user get -s {server} @name={username}
```

Documentation: [document/common#get-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid)

### DELETE /_users/{docid}

Remove a user:

```
rlx user rm -s {server} @name={username}
```

Documentation: [document/common#delete-db-docid](http://docs.couchdb.org/en/latest/api/document/common.html#delete--db-docid)

## Security

* Manual: `rlx help security`
* Help: `rlx --help security`

### GET /{db}/_security

Get security document (default subcommand):

```
rlx security -s {server} -d {db}
rlx security get -s {server} -d {db}
```

Documentation: [database/security#get-db-security](http://docs.couchdb.org/en/latest/api/database/security.html#get--db-_security)

### PUT /{db}/_security

Set security document:

```
rlx security set -s {server} -d {db} --file {file}
rlx security rm -s {server} -d {db}
```

Documentation: [database/security#put-db-security](http://docs.couchdb.org/en/latest/api/database/security.html#put--db-_security)

## Session

* Manual: `rlx help session`
* Help: `rlx --help session`

### POST /{db}/_session

Login with cookie authentication:

```
rlx session set -u {username} -p {password} -s {server}
rlx login -u {username} -p {password} -s {server}
```

Documentation: [server/authn#post-session](http://docs.couchdb.org/en/latest/api/server/authn.html#post--_session)

### GET /{db}/_session

Get user session:

```
rlx session get -u {username} -p {password} -s {server}
rlx whoami -u {username} -p {password} -s {server}
```

Documentation: [server/authn#get-session](http://docs.couchdb.org/en/latest/api/server/authn.html#get--_session)

### DELETE /{db}/_session

Logout of authenticated session:

```
rlx session rm -u {username} -p {password} -s {server}
rlx logout -u {username} -p {password} -s {server}
```

Documentation: [server/authn#delete-session](http://docs.couchdb.org/en/latest/api/server/authn.html#delete--_session)

## Replicate

* Manual: `rlx help repl`
* Help: `rlx --help repl`

### GET /_active_tasks

List active replications:

```
rlx repl ls -s {server}
```

Documentation: [server/common#get-active-tasks](http://docs.couchdb.org/en/latest/api/server/common.html#get--_active_tasks)

### POST /_replicate

Create a replication:

```
rlx repl add -s {server} @source={db} @target={db} @create_target=true @continuous=true
```

Documentation: [server/common#post-replicate](http://docs.couchdb.org/en/latest/api/server/common.html#post--_replicate)

### POST /_replicate

Remove a replication:

```
rlx repl rm -s {server} @source={db} @target={db} @create_target=true @continuous=true
```

Documentation: [server/common#post-replicate](http://docs.couchdb.org/en/latest/api/server/common.html#post--_replicate)

## Local Document

* Manual: `rlx help lcl`
* Help: `rlx --help lcl`

### PUT /{db}/_local/{docid}

Create a local document:

```
rlx lcl add -s {server} -d {db} -t {template} -i {docid} @bool=false @int=1024 @float=1.67 @arr=1,2,3 @str=value @nil=null
```

Documentation: [local#put-db-local-docid](http://docs.couchdb.org/en/latest/api/local.html#put--db-_local-docid)

### COPY /{db}/_local/{docid}

Copy a local document:

```
rlx lcl cp -s {server} -d {db} -i {docid} --destination {docid}
```

Documentation: [local#copy-db-local-docid](http://docs.couchdb.org/en/latest/api/local.html#copy--db-_local-docid)

### GET /{db}/_local/{docid}

Get a local document:

```
rlx lcl get -s {server} -d {db} -i {docid}
```

Documentation: [local#get-db-local-docid](http://docs.couchdb.org/en/latest/api/local.html#get--db-_local-docid)

### DELETE /{db}/_local/{docid}

Remove a local document:

```
rlx lcl rm -s {server} -d {db} -i {docid}
```

Documentation: [local#delete-db-local-docid](http://docs.couchdb.org/en/latest/api/local.html#delete--db-_local-docid)

## Configuration

* Manual: `rlx help conf`
* Help: `rlx --help conf`

### PUT /_config/{section}/{key}

Set server configuration value:

```
rlx conf set {section} {key} {value} -s {server}
```

Documentation: [server/configuration#put-config-section-key](http://docs.couchdb.org/en/latest/api/server/configuration.html#put--_config-section-key)

### GET /_config

Get server configuration:

```
rlx conf -s {server}
```

Documentation: [server/configuration#get-config](http://docs.couchdb.org/en/latest/api/server/configuration.html#get--_config)

### GET /_config/{section}

Get server configuration section:

```
rlx conf get {section} -s {server}
```

Documentation: [server/configuration#get-config-section](http://docs.couchdb.org/en/latest/api/server/configuration.html#get--_config-section)

### GET /_config/{section}/{key}

Get server configuration value:

```
rlx conf get {section} {key} -s {server}
```

Documentation: [server/configuration#get-config-section-key](http://docs.couchdb.org/en/latest/api/server/configuration.html#get--_config-section-key)

### DELETE /_config/{section}/{key}

Delete server configuration value:

```
rlx conf rm {section} {key} -s {server}
```

Documentation: [server/configuration#delete-config-section-key](http://docs.couchdb.org/en/latest/api/server/configuration.html#delete--_config-section-key)

## Log Level

* Manual: `rlx help level`
* Help: `rlx --help level`

### PUT /_config/log/level

Set server log level:

```
rlx level none -s {server}
rlx level error -s {server}
rlx level warn -s {server}
rlx level debug -s {server}
rlx level info -s {server}
```

Documentation: [server/configuration#put-config-section-key](http://docs.couchdb.org/en/latest/api/server/configuration.html#put--_config-section-key)

### GET /_config/log/level

Get server log level:

```
rlx level -s {server}
```

Documentation: [server/configuration#get-config-section-key](http://docs.couchdb.org/en/latest/api/server/configuration.html#get--_config-section-key)

Generated by [mdp(1)](https://github.com/tmpfs/mdp).