jessiefrance / shelljs-plugin-help

A help manual plugin for ShellJS.

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

shelljs-plugin-help's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Error updating PR

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update dependency eslint to v8.57.1
• chore(deps): update dependency eslint-plugin-import to v2.30.0
• chore(deps): update dependency mocha to v10.7.3
• chore(deps): update dependency eslint to v9
• chore(deps): update dependency nyc to v17
• fix(deps): update dependency marked to v14
• fix(deps): update dependency marked-terminal to v7
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency chai to v4.5.0
• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/setup-node action to v4
• chore(deps): update codecov/codecov-action action to v4
• chore(deps): update dependency chai to v5
• chore(deps): update dependency eslint-config-prettier to v9
• chore(deps): update dependency eslint-plugin-prettier to v5
• chore(deps): update dependency husky to v9
• chore(deps): update dependency lint-staged to v15
• chore(deps): update dependency prettier to v3
• chore(deps): update node.js to v20
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/ci.yml

• actions/checkout v3
• actions/setup-node v3
• codecov/codecov-action v3

npm

package.json

• marked ^4.3.0
• marked-terminal ^4.2.0
• chai 4.4.1
• eslint 8.56.0
• eslint-config-airbnb-base 15.0.0
• eslint-config-prettier 8.10.0
• eslint-plugin-import 2.29.1
• eslint-plugin-prettier 4.2.1
• husky 8.0.3
• lint-staged 13.3.0
• mocha 10.2.0
• nyc 15.1.0
• prettier 2.8.8
• shelljs 0.8.5
• shelljs ^0.8.5
• node >=v12.22.12

---

• Check this box to trigger a request for Renovate to run again on this repository