Home
Docs
GitHub
Pricing
Blog
Log In

Run Sandworm Audit for your App

Get started
Hold on, we're currently generating a fresh version of this report
Generated on Mar 9, 2024 via pnpm

shelljs 0.8.5

Portable Unix shell commands for Node.js
Package summary
Share
0
issues
3
licenses
12
MIT
7
ISC
1
BSD-3-Clause
Package created
2 Mar 2012
Version published
7 Jan 2022
Maintainers
3
Total deps
20
Direct deps
3
License
BSD-3-Clause

Issues

0
This package has no issues

Licenses

MIT License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
sublicense
private-use
Cannot
hold-liable
Must
include-copyright
include-license
12 Packages, Including:
balanced-match@1.0.2
brace-expansion@1.1.11
concat-map@0.0.1
function-bind@1.1.2
hasown@2.0.1
interpret@1.4.0
is-core-module@2.13.1
path-is-absolute@1.0.1
path-parse@1.0.7
rechoir@0.6.2
resolve@1.22.8
supports-preserve-symlinks-flag@1.0.0

ISC License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
Cannot
hold-liable
Must
include-copyright
include-license
7 Packages, Including:
fs.realpath@1.0.0
glob@7.2.3
inflight@1.0.6
inherits@2.0.4
minimatch@3.1.2
once@1.4.0
wrappy@1.0.2

BSD 3-Clause "New" or "Revised" License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
place-warranty
Cannot
use-trademark
hold-liable
Must
include-copyright
include-license
1 Packages, Including:
shelljs@0.8.5
Disclaimer

This deed highlights only some of the key features and terms of the actual license. It is not a license and has no legal value. You should carefully review all of the terms and conditions of the actual license before using the licensed material.

Sandworm is not a law firm and does not provide legal services. Distributing, displaying, or linking to this deed or the license that it summarizes does not create a lawyer-client or any other relationship.

Direct Dependencies

3
All Dependencies CSV
β“˜ This is a list of shelljs 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.
NameVersionSizeLicenseTypeVulnerabilities
glob7.2.315.08 kBISC
prod
interpret1.4.03.95 kBMIT
prod
rechoir0.6.23.69 kBMIT
prod

Visualizations

Frequently Asked Questions

What does shelljs do?

ShellJS is a robust solution for bringing Unix shell commands to Node.js, with multi-platform support for Windows, Linux, and OS X. It aids in replacing shell scripts with JavaScript, serving as a portable shell scripting library. This library has wide usage in various popular projects like Firebug, JSHint, ESLint, and Yeoman. Not only it streamlines shell operations into a consistent API, but is also an effective tool to eliminate the dependency on Unix commands and write OS-agnostic code.

How do you use shelljs?

To utilize ShellJS, you must first install it via npm with the following command:

$ npm install [-g] shelljs

Once installed, you can use ShellJS in your Node.js projects by requiring the ShellJS module:

var shell = require('shelljs');

Now you can use shell commands as JavaScript functions. For instance:

if (!shell.which('git')) {
  shell.echo('Sorry, this script requires git');
  shell.exit(1);
}

ShellJS commands can be used individually or chained together, allowing comprehensive bash-like scripting in JavaScript. Also note that you should refrain from using a global import for ShellJS i.e., require('shelljs/global') because it pollutes the global namespace.

Where are the shelljs docs?

The documents for ShellJs can be found on the same GitHub repository, located in the README file. You can access all the comprehensive documentation features related to ShellJs at https://github.com/shelljs/shelljs. You may also refer to https://www.npmjs.com/package/shelljs and http://documentup.com/shelljs/shelljs for its latest release and updates. For more profound details, you can visit the Wiki page linked within the GitHub repository.