@nodeguy/cli

command line interface helper functions

Stats

StarsIssuesVersionUpdatedCreatedSize
@nodeguy/cli
0.2.33 years ago3 years agoMinified + gzip package size for @nodeguy/cli in KB

Readme

These are simple tools for writing a Command Line Interface (CLI) program.

Features

Arguments Parser

Yes, I wrote Yet Another Arguments Parser, even though there are already plenty (including one called Yargs!). I wanted one with a simpler API that accepts standard data structures for defining options instead having to call methods.

Usage Example

"use strict";

const { cli } = require(`@nodeguy/cli`);

cli(
  {
    answer: [`The Answer to the Great Question`],
  },
  ({ answer }) => {
    console.log(`The answer is ${answer}.`);
  }
);
$ node test.js --help
Usage: test.js [options]

Options:
  --answer                   The Answer to the Great Question
  --help                     print usage instructions

$ node test.js --answer=42
The answer is 42.

cli(optionsSpecification, callback) -> (async)

optionsSpecification is an object in the following format:

{
  optionName1: [`description of option 1`, `default value1`]
  optionName2: [`description of option 2`, `default value2`],
  ...
}

The default values are optional and may be omitted.

callback is a function that will be called with an object of parsed options, .e.g.,

{
  optionName1: `default value1`
}

For more usage examples see test/index.js.

Shell

Run a shell script in the middle of a JavaScript program:

"use strict";

const { shell } = require(`@nodeguy/cli`);

;(async () => {
  await shell(`
# List the files in the root directory.
cd /
ls
`);
});

Copyright

Copyright 2018 David Braun

Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.