{"id":19238540,"url":"https://github.com/tmpfs/rlx","last_synced_at":"2025-09-06T14:40:28.133Z","repository":{"id":19810275,"uuid":"23070582","full_name":"tmpfs/rlx","owner":"tmpfs","description":"Command line interface for couchdb","archived":false,"fork":false,"pushed_at":"2016-03-08T10:55:13.000Z","size":1585,"stargazers_count":25,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-01T10:51:22.538Z","etag":null,"topics":["cli","couchdb","database"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tmpfs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-18T12:36:50.000Z","updated_at":"2022-09-21T23:29:59.000Z","dependencies_parsed_at":"2022-08-25T20:50:56.750Z","dependency_job_id":null,"html_url":"https://github.com/tmpfs/rlx","commit_stats":null,"previous_names":[],"tags_count":429,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmpfs%2Frlx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmpfs%2Frlx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmpfs%2Frlx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmpfs%2Frlx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tmpfs","download_url":"https://codeload.github.com/tmpfs/rlx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248950340,"owners_count":21188253,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","couchdb","database"],"created_at":"2024-11-09T16:33:23.256Z","updated_at":"2025-09-06T14:40:28.110Z","avatar_url":"https://github.com/tmpfs.png","language":"JavaScript","readme":"Table of Contents\n=================\n\n* [rlx](#rlx)\n  * [Install](#install)\n  * [Quick Start](#quick-start)\n  * [Documentation](#documentation)\n  * [Usage](#usage)\n  * [Developer](#developer)\n    * [Test](#test)\n      * [Environment](#environment)\n    * [Coverage](#coverage)\n    * [Documentation](#documentation-1)\n    * [Manual](#manual)\n    * [Lint](#lint)\n    * [Readme](#readme)\n    * [Cheatsheet](#cheatsheet)\n\nrlx\n===\n\n[\u003cimg src=\"https://travis-ci.org/tmpfs/rlx.svg\" alt=\"Build Status\"\u003e](https://travis-ci.org/tmpfs/rlx)\n[\u003cimg src=\"http://img.shields.io/npm/v/rlx.svg\" alt=\"npm version\"\u003e](https://npmjs.org/package/rlx)\n[\u003cimg src=\"https://coveralls.io/repos/tmpfs/rlx/badge.svg?branch=master\u0026service=github\u0026v=1\" alt=\"Coverage Status\"\u003e](https://coveralls.io/github/tmpfs/rlx?branch=master).\n\nCommand line interface for [couchdb](http://couchdb.apache.org) designed for POSIX systems.\n\nRequires [node](http://nodejs.org) and [npm](http://www.npmjs.org).\n\n## Install\n\n```\nnpm i -g rlx\n```\n\n## Quick Start\n\nStart [couchdb](http://couchdb.apache.org) in it's default configuration, then run:\n\n```\nrlx i               # Launch interactive console\ncd :lh              # Use alias to `cd http://localhost:5984`\ndb ls               # List databases\ndb add mydb         # Create database\ncd mydb             # Use new database\ndoc add -i mydoc    # Create a new document\ndoc edit mydoc      # Edit document with `vim`\ndoc get mydoc       # Print modified and saved document\nhelp                # Learn more commands in the manual\nq                   # Quit interactive session\n```\n\n## Documentation\n\nThe documentation for the program is available via the `help` command, for those familiar with [couchdb](http://couchdb.apache.org) the [cheatsheet](https://github.com/tmpfs/rlx/blob/master/doc/cheatsheet.md) is a good place to start.\n\n## Usage\n\n```\nUsage: rlx \u003ccommand\u003e\n\nwhere \u003ccommand\u003e is one of:\n    admin, alias, as, application, app, attach, att, batch,\n    bulk, config, conf, database, db, document, doc, edit, help,\n    http, tt, info, interactive, i, json, j, level, lvl, lint,\n    local, lcl, log, login, in, logout, out, runconf, rc,\n    replicate, repl, restart, security, sec, session, sess,\n    stats, system, sys, tasks, tpl, user, usr, uuids, whoami\n\nrlx --help \u003ccmd\u003e         quick help on \u003ccmd\u003e\nrlx help \u003ccmd\u003e           documentation for \u003ccmd\u003e\nrlx i                    launch interactive console\n\nrlx@0.3.2 /home/muji/git/rlx\n```\n\n## Developer\n\nDeveloped against `couchdb@1.6.0`, behaviour in earlier versions is undefined.\n\n### Test\n\nTests require a clean [couchdb](http://couchdb.apache.org) installation running in *admin party* mode.\n\n```\nnpm test\n```\n\nIf an rc file is present (`~/.rlx/.rlxrc`) the tests may fail as the default configuration is required you should ensure this file does not exist before running tests.\n\nQuick test executes commands in series but bypasses code coverage and test assertions:\n\n```\nnpm run qt\n```\n\n#### Environment\n\n* `rlx_test_server` - Specify the server to run tests against, default is `http://localhost:5984`.\n\n### Coverage\n\nTo run test specs and generate code coverage:\n\n```\nnpm run cover\n```\n\n### Documentation\n\nTo generate all documentation (manual, readme, cheatsheet etc):\n\n```\nnpm run docs\n```\n\n### Manual\n\nTo generate man pages run (requires [manpage](https://github.com/cli-kit/cli-manpage)):\n\n```\nnpm run manual\n```\n\nGenerated man pages are in the [man](https://github.com/tmpfs/rlx/blob/master/doc/man) directory, to dynamically generate man pages set `NODE_ENV` to `devel` and execute the help command:\n\n```\nNODE_ENV=devel ./bin/rlx help db\n```\n\n### Lint\n\nRun the source tree through [jshint](http://jshint.com) and [jscs](http://jscs.info):\n\n```\nnpm run lint\n```\n\n### Readme\n\nTo build the readme file from the partial definitions (requires [mdp](https://github.com/tmpfs/mdp)):\n\n```\nnpm run readme\n```\n\n### Cheatsheet\n\nTo generate the cheatsheet (requires [mdp](https://github.com/tmpfs/mdp)):\n\n```\nnpm run cheatsheet\n```\n\nGenerated by [mdp(1)](https://github.com/tmpfs/mdp).\n\n[couchdb]: http://couchdb.apache.org\n[node]: http://nodejs.org\n[npm]: http://www.npmjs.org\n[man]: https://github.com/tmpfs/rlx/blob/master/doc/man\n[mdp]: https://github.com/tmpfs/mdp\n[manpage]: https://github.com/cli-kit/cli-manpage\n[jshint]: http://jshint.com\n[jscs]: http://jscs.info\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmpfs%2Frlx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftmpfs%2Frlx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmpfs%2Frlx/lists"}