Skip to content

abbotto/shellcmd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Run shell commands from NodeJS

Package Information

NPM version GitHub version

Usage

require('shellcmd')(
	'cmd 1',
	'cmd 2',
	'cmd n',
	'...',
	{ options }
	, 1
)

Force stdout output for errors

When 1 is passed as the final argument, stdout will be returned instead of an object when an error is encountered.

Options [Object]

  • cwd [string]
    • Current working directory of the child process
  • env [object]
    • Environment key-value pairs
  • encoding [string]
    • Default: 'utf8'
  • shell [string]
    • Shell where the command will be executed
    • Default:
      • UNIX: /bin/sh
      • Windows: process.env.ComSpec
  • timeout [number]
    • Default: 0
  • maxBuffer [number]
    • Largest amount of data in bytes allowed on stdout or stderr.
    • If exceeded, the child process is terminated.
    • Default: 200*1024
  • killSignal [string | integer]
    • Default: 'SIGTERM'
  • uid [number]
    • Sets the user identity of the process.
  • gid [number]
    • Sets the group identity of the process.