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

konzole

v1.0.2

Published

Console applications for the masses

Downloads

8

Readme

Konzole

Console applications in NodeJS made easy as hell.

Konzole

Usage

Require a konzole within a simple node script and run it:

var konzole = require('./konzole')('MY FIRST CONSOLE', "1.0.0");

konzole.run();

you will see an help script describing the commands that are registered within this console (only help, for now).

Let's declare a new ls command that will simply console.log the contents of a directory:

var konzole = require('konzole')('MY FIRST CONSOLE', "1.0.0");
var kommand = require('kommand');
var fs = require('fs');

var ls = new kommand('Lists contents of a directory');

ls.run = function(konzole) {
    console.log(fs.readdirSync('.'))
};

konzole.addCommand('ls', ls);

konzole.run();

et-voila:

ls command

Options

To add options to your command, simply declare them as dependencies of your command:

var kommand = require('kommand');
var kommand = require('option');

var ls = new kommand('Lists contents of a directory', [new option('d', 'dir', '.')]);

ls.run = function(konzole, input) {
    console.log(fs.readdirSync(input.getOption('d')))
};

the three arguments of an option are:

  • its name (-d)
  • its alias (--dir)
  • its default value (.)

Now you can simply use your pimped command with node index.js ls --dir=/home/you/something.

Example console

In this example we are adding to the console the already-seen ls command and a new, quote, command that will retrieve a random quote from the internet.

Just like that.

var konzole = require('konzole')('MY FIRST CONSOLE', "1.0.0");
var kommand = require('kommand');
var option  = require('option');
var fs = require('fs');
var colors = require('colors');
var _ = require('lodash');
var HTTP = require("q-io/http");

var ls = new kommand('Lists contents of a directory', [new option('d', 'dir', '.')]);
ls.run = function(konzole, input) {
    var directory = input.getOption('dir');

    console.log(fs.readdirSync(directory));
};

var quote = new kommand('Retrieves a random quote');
quote.run = function(konzole, input) {
    HTTP.request({url: "http://www.iheartquotes.com/api/v1/random.json", method: 'GET'}).then(function(response){
        response.body.read().then(function (buffer) {
            console.log(JSON.parse(buffer.toString('UTF-8')).quote.inverse);
        });
    })
};

konzole.addCommand('ls', ls);
konzole.addCommand('quote', quote);

konzole.run();

Konzole

Have fun!

Tests

tests

Gimme some time :)