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

command-interface

v4.2.1

Published

Build powerful command-line interfaces from simple ES6 modules.

Downloads

243

Readme

Build Status Title

Build powerful command-line interfaces from simple ES6 modules.

Usage

Each command is defined within an ES module like so:

// commands/foo.cmd.js

export const name = 'foo';
export const description = 'A thing that does something.';
export const alias = 'f'; // String or Array.
export const group = 'Utilities';

export const args = {
  'param1': 'the first parameter',
  'param2': 'the second param',
  '--foo': 'a boolean flag',
};

export const validate = (args) => args;

export default (args) {
  // Run the command.
};

All exports are optional. If a name is omitted the name of the module is assumed. The only thing you really need is the default export function to invoke when the command is run.

If you don't wish to export the command as a default export, your can export a function named cmd, eg:

export async function cmd(args) {
  // Run the command.
}

To initialize the CLI, from the entry point of your module pass a glob pattern representing your JS modules that are commands. Typically these have a .cmd.js suffix:

import command from 'command-interface';
command('./**/*.cmd.js');

This will load all modules with the .cmd.js suffix anywhere within the project and produce the following index list when run with no command argument:

Index

Command Help

To get details on a specific command:

node . foo -h

Command Help

Run a Command

node . foo param1 flag=123 -f

The parameter and option arguments are passed to the command function as the args parameter.

{
  args: ['param1'],
  options: { flag: 123, f: true },
}

See minimist for more.

Example

cd lib/examples
node .

Tests

npm test

Usages

  • msync - A powerful toolkit for building and syncing multiple node-modules in a flexibly defined workspace.

  • new-file - Simple file templates.

Next

  • Update checker