shelljs-plugin-help

A ShellJS help documentation plugin for getting quick documentation on ShellJS commands.

Installation

npm i shelljs
npm i shelljs-plugin-help

Usage

• Get information on a ShellJS command: help(COMMAND)

COMMAND is an optional string representing a ShellJS command.

• See available ShellJS documentation entries with no arguments passed: help()

Examples

To get more information on the ShellJS 'sed' command, you can do the following:

const shell = require('shelljs');
require('shelljs-plugin-help');

const sedDocs = shell.help('sed');
shell.echo(sedDocs.stdout);

To see a list of available shelljs-plugin-help documentation entries, you can call help without any arguments:

const shell = require('shelljs');
require('shelljs-plugin-help');

const availableDocs = shell.help();
shell.echo(sedDocs.stdout);

License

MIT