Futon for your command line
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin [futon] changed names to get npm Jun 12, 2012
commands [fix] Add document update to help Dec 26, 2013
get-couchdb-logo.js [ux] makes futon logo a little better Jun 13, 2012



futon on your command line

play futon command line client video in codestream


futoncli is a command line tool for managing and interacting with couchdb. it's open-source and easy to use.

futoncli requires npm, the node package manager.

one-line npm install

[sudo] curl http://npmjs.org/install.sh | sh

one-line futoncli install

[sudo] npm install futon -g


futoncli is designed with serendipity in mind. you should be able to work with it without the need for instructions.

futoncli uses nano under the hood, so most of the code is actually there.

even thought futoncli works it is not a finished product as it was hacked together in a couple of hours. you are likely to find problems with it and you are encouraged to send in a pull request for any issue you find.

.futoncliconf file

all configuration data for your local futoncli install is located in the .futoncliconf file in your home directory. directly modifying this file is not really advised. you should be able to make all configuration changes via:

futon config

TypeError: Arguments to path.join must be strings

to get futoncli working it needs the HOME environment variable. if you want to change it before execution do this:

HOME=path/to/home/directory futon

if you're using windows set the variable before calling foutoncli:

SET HOME=C:\Path\To\Home\Directory

or to set it permanently add a new environment variable.


$ npm test


everyone is welcome to contribute with patches, bug-fixes and new features. check roadmap for ideas of things i know are broken. also issues.

  1. create an issue on github so the community can comment on your idea
  2. fork futoncli in github
  3. create a new branch git checkout -b my_branch
  4. create tests for the changes you made
  5. make sure you pass both existing and newly inserted tests
  6. commit your changes
  7. push to your branch git push origin my_branch
  8. create a pull request

to run tests make sure you npm test but also run tests without mocks:


(oo)--',- in caos



copyright 2011 nuno job , julian duque @julianduque, and contributors (oo)--',--

licensed under the apache license, version 2.0 (the "license"); you may not use this file except in compliance with the license. you may obtain a copy of the license at


unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. see the license for the specific language governing permissions and limitations under the license.