npmpackage.info

exec-sh

node helper to execute shell commands

0.4.0

MIT

JavaScript

Installations

npm install exec-sh

Score

98.7

Supply Chain

Quality

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

24

Closed

9

Merged

15

Issues

Open

0

Total

8

Closed

8

Releases

v0.4.0

Published on 26 Mar 2021

v0.3.4

Published on 07 Nov 2019

v0.2.2

Published on 26 Jun 2018

0.2.1

Published on 07 Sept 2017

View all 4 releases

Contributors

View all 5 contributors

Developer

tsertkov

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

15.10.0

NPM Version

7.5.3 Statistics

63 Stars

75 Commits

10 Forks

3 Watching

1 Branches

5 Contributors

Updated on 14 May 2024

Languages

JavaScript (96.09%)

TypeScript (3.91%)

Total Downloads

Cumulative downloads

Total Downloads

2,467,611,242

Last day

-10.3%

1,430,105

Compared to previous day

Last week

2.7%

9,260,817

Compared to previous week

Last month

59.9%

32,444,221

Compared to previous month

Last year

-31.5%

285,822,471

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@types/node coveralls jsdoc jshint mocha nyc sinon standard typescript

Versions

exec-sh

Execute shell command forwarding all stdio streams.

Features

exec-sh is a wrapper for child_process.spawn with some improvements:

Cross platform command execution:
- Windows: cmd /C COMMAND
- others: sh -c COMMAND
Forwards all stdio streams to current terminal (by default):
- execSh("bash")
- execsh("echo -n Say: && read i && echo Said:$i")
stdout and stderr are passed to callback when available
- execSh("pwd", console.log)

Showcase

1// JavaScript
2
3execSh("echo hello exec-sh && bash", { cwd: "/home" }, function(err){
4  if (err) {
5    console.log("Exit code: ", err.code);
6  }
7});

1# Terminal output: interactive bash session
2
3hello exec-sh
4bash-3.2$ pwd
5/home
6bash-3.2$ exit 99
7exit
8Exit code:  99

Usage

1const execSh = require("../");
2
3// run interactive bash shell
4execSh("echo lorem && bash", { cwd: "/home" }, (err) => {
5  if (err) {
6    console.log("Exit code: ", err.code);
7    return;
8  }
9
10  // collect streams output
11  const child = execSh(["bash -c id", "echo lorem >&2"], true,
12    (err, stdout, stderr) => {
13      console.log("error: ", err);
14      console.log("stdout: ", stdout);
15      console.log("stderr: ", stderr);
16    });
17});

Promise Interface

1const execShPromise = require("exec-sh").promise;
2
3// run interactive bash shell
4const run = async () => {
5  let out;
6
7  try {
8    out = await execShPromise('pwd', true);
9  } catch (e) {
10    console.log('Error: ', e);
11    console.log('Stderr: ', e.stderr);
12    console.log('Stdout: ', e.stdout);
13
14    return e;
15  }
16
17  console.log('out: ', out.stdout, out.stderr);
18}
19
20run();

Public API

`execSh(command, [options], [callback])`

Execute shell command forwarding all stdio.

Parameters:

command {String|Array} - The command to run, or array of commands
[options] {Object|TRUE} - Options object passed directly to child_process.spawn, when TRUE then { stdio: null } used
[callback] {Function} - callback(err, stdout, stderr)
err {Error|NULL} - Error object. Has code property containing last command exit code when available
stdout {String|NULL} - aggregated stdout or NULL if not available
stderr {String|NULL} - aggregated stderr or NULL if not available

Return Values:

Returns ChildProcess object.

Scripts

npm test - run tests
npm run jsdoc - build jsdoc
npm run dev - run tests continuously

License

The MIT License (MIT)

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

3.6

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to exec-sh

@doctorwork/components

1.1.2

``` find . -name '*.scss' -exec sh -c 'mv "$0" "${0%.scss}.styl"' {} \;

@actions/exec

1.1.1

Actions exec lib

exec-limiter

3.2.13

Limit the shell execution commands to <x> calls same time.

@percy/cli-exec

1.30.3

Percy CLI commands for running a local snapshot server using [`@percy/core`](./packages/core).