3f/eoc-cli

CouchDB Command-Line Client.

, _(*1)

Elephant on Couch Command-Line Interface

EoC CLI is a CouchDB's Command-Line Interface (CLI) made in PHP programming language., _(*2)

Composer Installation

To install EoC CLI, you first need to install Composer, a Package Manager for PHP, following those few steps:, _(*3)

``` sh curl -s https://getcomposer.org/installer | php, <sub>(*4)</sub>

You can run this command to easily access composer from anywhere on your system:

``` sh
sudo mv composer.phar /usr/local/bin/composer

EoC CLI Installation

Once you have installed Composer, it's easy install Elephant on Couch CLI., <sub>(*5)</sub>

1. Move into the directory where you prefer install EoC CLI: sh cd /usr/local, <sub>(*6)</sub>

2. Create a project for EoC CLI: sh sudo composer create-project 3f/eoc-cli, <sub>(*7)</sub>

3. For your convenience create a symbolic link for the couch executable in your /usr/local/bin directory: sh sudo ln -s /user/local/eoc-cli/bin/couch.php /usr/local/bin/couch, <sub>(*8)</sub>

Supported Commands

Lists commands. ``` sh couch list [--xml] [--raw] [--format="..."] [namespace], <sub>(*9)</sub>

Displays help for a command. 
``` sh
couch help [--xml] [--format="..."] [--raw] [command_name]

Connects to CouchDB server. ``` sh couch connect [-s|--server[="..."]] user, <sub>(*10)</sub>

Uses the specified database. 
``` sh
couch use database

Alias of use. ``` sh couch select database, <sub>(*11)</sub>

Creates a new database.
``` sh
couch create database

Deletes the specified database, if not in use. ``` sh couch delete database, <sub>(*12)</sub>

Displays information about the selected database.
``` sh
couch info

Starts a compaction for the current selected database or just a set of views. ``` sh couch compact [--design-doc="..."], <sub>(*13)</sub>

Removes all outdated view indexes.
``` sh
couch cleanup

Makes sure all uncommited database changes are written and synchronized to the disk. ``` sh couch commit, <sub>(*14)</sub>

Returns the tail of the server's log file.
``` sh
couch log [--bytes[="..."]]

Restarts CouchDB server. ``` sh couch restart, <sub>(*15)</sub>

Gets the list of active tasks. 
``` sh
couch status

Returns a list of generated UUIDs. ``` sh couch uuids [--count[="..."]], <sub>(*16)</sub>

Displays CouchDB server and client versions. 
``` sh
couch version

Returns a list of all databases on this server. ``` sh couch alldbs, <sub>(*17)</sub>

Queries a view and outputs the result. 
``` sh
couch query [--key="..."] [--startkey="..."] [--endkey="..."] [--startkey-docid="..."] 
[--endkey-docid="..."] [--limit="..."] [--group-results] [--group-level="..."] 
[--do-not-reduce] [--include-docs] [--exclude-results] [--exclude-endkey] 
[--reverse-order] [--skip="..."] [--include-conflicts] [--include-missing-keys] 
[--map="..."] [--reduce="..."] [--language="..."] design-doc/view-name [keys1] ... [keysN]

Requirements

PHP 5.4.7 or above. Shmop library is also required., <sub>(*18)</sub>

Authors

Filippo F. Fadda - filippo.fadda@programmazione.it - http://www.linkedin.com/in/filippofadda, <sub>(*19)</sub>

License

Elephant on Couch Command-Line Interface is licensed under the Apache License, Version 2.0 - see the LICENSE file for details., <sub>(*20)</sub>