Simplecmds NPM

SimpleCMDs

SimpleCMDs is a library designed to help you easily create custom command line interfaces.

Features

:pencil2: Create custom commands.
:speech_balloon: Multiple arguments per command.
:guardsman: Argument type and amount enforcing (validation).
:link: Easily chain commands.
:question: Dynamic, customizable help menu.

Install and Import

Installing

npm i simplecmds

Importing

const cmds = require('simplecmds');

Creating a basic interface

I believe the best way to learn a technology is to create something with it. In this section I will create a simple interface utilizing all of the features of this package. There will be links that go into more detail at the top of each section for you to reference as we go.

The Project (HTTP2-server.js):

In this project, we will be creating a pseudo profile creator for a HTTP2 server. It will have four commands:

command	usage	description
save	`'-s --save <name>'`	Create a new config profile
key	`'-k --key <path>'`	Set the private key path
cert	`'-c --cert <path>'`	Set the certificate path
port	`'-p --port <number>'`	Set the port number (optional)

The usage of the program will look as such:

~ > node HTTP2-server -s 'profileName' -k './path/to/key' -c './path/to/cert' -p 443
HTTP2-server: 'profileName' created!

We will be making use of Node's fs module so be sure to require it at the top of the file!

const fs = require('fs');

Boilerplate

const simplecmds = require('simplecmds');

const options = {};
const commands = {};

simplecmds
    .set(options)
    .commands(commands)
    .parse(process.argv);

Program Options

[ Program Options Wiki Page ]

const options = {
  description: 'Save HTTP2 server profiles.',
  defaults: {
    rules: '<string>',
    amount: 1,
  }
};

Explanation

I excluded the version and debug options in order to use their default values.
The program description will be used when printing the help menu (node createProfile -h).
The defaults property sets properties that each command will inherit when being created.

Command Options

[ Command Options Wiki Page ]

// This string will be used for the 'save' command's help page.
const saveHelpPage = 
"This command lets you create a configuration profile for your server.\n\n\
* You must provide a key and certificate in order to create a profile.\n\n\
You can provide them using the following commands:\n\
  -k --key     Set the private key path\n\
  -c --cert    Set the certificate path\n\n\
You can provide an optional port to change it from the default (443):\n\
  -p --port    Set the port number";


// Each one of these inherits the program option's 'defaults' properties.
const commands = {
  // inherits amount: 1
  save: {
    usage: '-s --save <profile>',
    description: 'Create a new config profile',
    callback: saveProfile,
    rules: '<number,string>',
    help: saveHelpPage,
  },

  // inherits amount: 1 and rules: '<string>'
  key: {
    usage: '-k --key <path>',
    description: 'Set the private key path',
  },

  // inherits amount: 1 and rules: '<string>'
  cert: {
    usage: '-c --cert <path>',
    description: 'Set the certificate path',
  },

  // inherits amount: 1
  port: {
    usage: '-p --port <number>',
    description: 'Set the port number (optional)',
    rules: '<number>',
  }
};

Explanation

save command

I provided a callback function: saveProfile. This will be run when the command is issued.
I provided a help page for the command: saveHelpPage. Accessible via HTTP2-server -h (save || s).
It inherits amount from defaults and ensures that a number or string was given.

key command

A basic setter command.
It inherits rules and amount from defaults.

cert command

A basic setter command.
It inherits rules and amount from defaults.

port command

A basic setter command.
It inherits amount from defaults and ensures that a number was given.

Callback Function

[ Callback Wiki Page ]

function saveProfile({args: [name], valid, commands: {key, cert, port}}) {
  // Ensure 'save', 'key', and 'cert' arguments were all valid.
  if (valid && key.valid && cert.valid) {

    // Convert the data to JSON.
    const config = JSON.stringify({
      name,
      key: key.args[0],
      cert: cert.args[0],
      port: (port.valid && port.args[0] || 443),
    }, null, 2);

    // Create the directory if it does not exist yet.
    const directory = `${__dirname}/profiles`;

    if (!fs.existsSync(directory)) {
      fs.mkdirSync(directory);
    }

    // Write the config to a file and alert the user.
    fs.writeFileSync(`${directory}/${name}.json`, config);
    return console.log(`HTTP2-server: '${name}' created!`);
  }

  // Print the help page for 'save' if any commands were invalid.
  this.help({exit: true, command: 'save'});
}

Explanation

Our saveProfile function will ensure that the save, cert, and key arguments were all valid types. If that is the case it will create a new file as such: ./profiles/[name].json.

Inside this file will contain the name of the profile, key and cert paths, and the port number. If the user did not provide a port number it will default to 443.

If they provided invalid argument types, or missed a required command, they will see the help page for save.

We can check if it works by issuing the following commands:

# Create a profile: 'profile.json'.
~ > node createProfile -s 'profile' -k './path/to/key' -c './path/to/cert' -p 4321
HTTP2-server: 'profile' created!

# Invalid usage; it will output the save command's help page.
~ > node createProfile -s 'profile' -k ./path/to/key

Full Code

The full code can be found in the examples directory of the simplecmds repository as well as two other examples.

Final Note

I hope this has given you an idea of how to use this package. If you have any questions please read the wiki or post an issue and I'll be happy to help. Feature requests are welcomed as well!

Links: [ Wiki ] [ Issue Tracker ] [ NPM ]