npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rlx

v0.3.2

Published

Command line interface for couchdb

Downloads

125

Readme

Table of Contents

rlx

.

Command line interface for couchdb designed for POSIX systems.

Requires node and npm.

Install

npm i -g rlx

Quick Start

Start couchdb in it's default configuration, then run:

rlx i               # Launch interactive console
cd :lh              # Use alias to `cd http://localhost:5984`
db ls               # List databases
db add mydb         # Create database
cd mydb             # Use new database
doc add -i mydoc    # Create a new document
doc edit mydoc      # Edit document with `vim`
doc get mydoc       # Print modified and saved document
help                # Learn more commands in the manual
q                   # Quit interactive session

Documentation

The documentation for the program is available via the help command, for those familiar with couchdb the cheatsheet is a good place to start.

Usage

Usage: rlx <command>

where <command> is one of:
    admin, alias, as, application, app, attach, att, batch,
    bulk, config, conf, database, db, document, doc, edit, help,
    http, tt, info, interactive, i, json, j, level, lvl, lint,
    local, lcl, log, login, in, logout, out, runconf, rc,
    replicate, repl, restart, security, sec, session, sess,
    stats, system, sys, tasks, tpl, user, usr, uuids, whoami

rlx --help <cmd>         quick help on <cmd>
rlx help <cmd>           documentation for <cmd>
rlx i                    launch interactive console

[email protected] /home/muji/git/rlx

Developer

Developed against [email protected], behaviour in earlier versions is undefined.

Test

Tests require a clean couchdb installation running in admin party mode.

npm test

If 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.

Quick test executes commands in series but bypasses code coverage and test assertions:

npm run qt

Environment

  • rlx_test_server - Specify the server to run tests against, default is http://localhost:5984.

Coverage

To run test specs and generate code coverage:

npm run cover

Documentation

To generate all documentation (manual, readme, cheatsheet etc):

npm run docs

Manual

To generate man pages run (requires manpage):

npm run manual

Generated man pages are in the man directory, to dynamically generate man pages set NODE_ENV to devel and execute the help command:

NODE_ENV=devel ./bin/rlx help db

Readme

To build the readme file from the partial definitions (requires mdp):

npm run readme

Cheatsheet

To generate the cheatsheet (requires mdp):

npm run cheatsheet

Generated by mdp(1).