Repository files navigation

ShellJS is a portable(Windows/Linux/OS X) implementation of Unix shellcommands on top of the Node.js API. You can use it to eliminate your shellscript's dependency on Unix while still keeping its familiar and powerfulcommands. You can also install it globally so you can run it from outside Nodeprojects - say goodbye to those gnarly Bash scripts!

ShellJS is proudly tested on every node release sincev4!

The project isunit-tested and battle-tested in projects like:

• Firebug - Firefox's infamous debugger
• JSHint &ESLint - popular JavaScript linters
• Zepto - jQuery-compatible JavaScript library for modern browsers
• Yeoman - Web application stack and development tool
• Deployd.com - Open source PaaS for quick API backend generation
• Andmany more.

If you have feedback, suggestions, or need help, feel free to post in ourissuetracker.

Think ShellJS is cool? Check out some related projects in ourWikipage!

Upgrading from an older version? Check out ourbreakingchanges page to seewhat changes to watch out for while upgrading.

If you just want cross platform UNIX commands, checkout our new projectshelljs/shx, a utility to exposeshelljs tothe command line.

For example:

$ shx mkdir -p foo$ shx touch foo/bar.txt$ shx rm -rf foo

ShellJS now supports third-party plugins! You can learn more about using pluginsand writing your own ShellJS commands inthewiki.

For documentation on all the latest features, check out ourREADME. To read docs that are consistentwith the latest release, check outthe npmpage orshelljs.org.

Via npm:

$ npm install [-g] shelljs

varshell=require('shelljs');if(!shell.which('git')){shell.echo('Sorry, this script requires git');shell.exit(1);}// Copy files to release dirshell.rm('-rf','out/Release');shell.cp('-R','stuff/','out/Release');// Replace macros in each .js fileshell.cd('lib');shell.ls('*.js').forEach(function(file){shell.sed('-i','BUILD_VERSION','v0.1.2',file);shell.sed('-i',/^.*REMOVE_THIS_LINE.*$/,'',file);shell.sed('-i',/.*REPLACE_LINE_WITH_MACRO.*\n/,shell.cat('macro.js'),file);});shell.cd('..');// Run external tool synchronouslyif(shell.exec('git commit -am "Auto-commit"').code!==0){shell.echo('Error: Git commit failed');shell.exit(1);}

If you need to pass a parameter that looks like an option, you can do so like:

shell.grep('--','-v','path/to/file');// Search for "-v", no grep optionsshell.cp('-R','-dir','outdir');// If already using an option, you're done

We no longer recommend using a global-import for ShellJS (i.e.require('shelljs/global')). While still supported for convenience, thispollutes the global namespace, and should therefore only be used with caution.

Instead, we recommend a local import (standard for npm packages):

varshell=require('shelljs');shell.echo('hello world');

All commands run synchronously, unless otherwise stated.All commands accept standard bash globbing characters (*,?, etc.),compatible with thenode glob module.

For less-commonly used commands and features, please check out ourwikipage.

Available options:

• -n: number all output lines

Examples:

varstr=cat('file*.txt');varstr=cat('file1','file2');varstr=cat(['file1','file2']);// same as above

Returns a string containing the given file, or a concatenated stringcontaining the files if more than one file is given (a new line character isintroduced between each file).

Changes to directorydir for the duration of the script. Changes to homedirectory if no argument is supplied.

Available options:

• -v: output a diagnostic for every file processed
• -c: like verbose but report only when a change is made
• -R: change files and directories recursively

Examples:

chmod(755,'/Users/brandon');chmod('755','/Users/brandon');// same as abovechmod('u+x','/Users/brandon');chmod('-R','a-w','/Users/brandon');

Alters the permissions of a file or directory by either specifying theabsolute permissions in octal form or expressing the changes in symbols.This command tries to mimic the POSIX behavior as much as possible.Notable exceptions:

• In symbolic modes, 'a-r' and '-r' are identical. No consideration isgiven to the umask.
• There is no "quiet" option since default behavior is to run silent.

Available options:

• -f: force (default behavior)
• -n: no-clobber
• -u: only copy if source is newer than dest
• -r,-R: recursive
• -L: follow symlinks
• -P: don't follow symlinks

Examples:

cp('file1','dir1');cp('-R','path/to/dir/','~/newCopy/');cp('-Rf','/tmp/*','/usr/local/*','/home/tmp');cp('-Rf',['/tmp/*','/usr/local/*'],'/home/tmp');// same as above

Copies files.

Available options:

• -n: Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated.
• -q: Supresses output to the console.

Arguments:

• dir: Makes the current working directory be the top of the stack, and then executes the equivalent ofcd dir.
• +N: Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
• -N: Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.

Examples:

// process.cwd() === '/usr'pushd('/etc');// Returns /etc /usrpushd('+1');// Returns /usr /etc

Save the current directory on the top of the directory stack and then cd todir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.

Available options:

• -n: Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated.
• -q: Supresses output to the console.

Arguments:

• +N: Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero.
• -N: Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero.

Examples:

echo(process.cwd());// '/usr'pushd('/etc');// '/etc /usr'echo(process.cwd());// '/etc'popd();// '/usr'echo(process.cwd());// '/usr'

When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.

Available options:

• -c: Clears the directory stack by deleting all of the elements.
• -q: Supresses output to the console.

Arguments:

• +N: Displays the Nth directory (counting from the left of the list printed by dirs when invoked without options), starting with zero.
• -N: Displays the Nth directory (counting from the right of the list printed by dirs when invoked without options), starting with zero.

Display the list of currently remembered directories. Returns an array of paths in the stack, or a single path if +N or -N was specified.

See also: pushd, popd

Available options:

• -e: interpret backslash escapes (default)
• -n: remove trailing newline from output

Examples:

echo('hello world');varstr=echo('hello world');echo('-n','no newline at end');

Prints string to stdout, and returns string with additional utility methodslike.to().

Available options:

• async: Asynchronous execution. If a callback is provided, it will be set totrue, regardless of the passed value (default:false).
• silent: Do not echo program output to console (default:false).
• encoding: Character encoding to use. Affects the returned stdout and stderr values, andwhat is written to stdout and stderr when not in silent mode (default:'utf8').
• and any option available to Node.js'schild_process.exec()

Examples:

varversion=exec('node --version',{silent:true}).stdout;varchild=exec('some_long_running_process',{async:true});child.stdout.on('data',function(data){/* ... do something with data ... */});exec('some_long_running_process',function(code,stdout,stderr){console.log('Exit code:',code);console.log('Program output:',stdout);console.log('Program stderr:',stderr);});

Executes the givencommandsynchronously, unless otherwise specified. When in synchronousmode, this returns a ShellString (compatible with ShellJS v0.6.x, which returns an objectof the form{ code:..., stdout:... , stderr:... }). Otherwise, this returns the child processobject, and thecallback gets the arguments(code, stdout, stderr).

Not seeing the behavior you want?exec() runs everything throughshby default (orcmd.exe on Windows), which differs frombash. If youneed bash-specific behavior, try out the{shell: 'path/to/bash'} option.

Note: For long-lived processes, it's best to runexec() asynchronously asthe current synchronous implementation uses a lot of CPU. This should be gettingfixed soon.

Examples:

find('src','lib');find(['src','lib']);// same as abovefind('.').filter(function(file){returnfile.match(/\.js$/);});

Returns array of all files (however deep) in the given paths.

The main difference fromls('-R', path) is that the resulting file namesinclude the base directories, e.g.lib/resources/file1 instead of justfile1.

Available options:

• -v: Inverse the sense of the regex and print the lines not matching the criteria.
• -l: Print only filenames of matching files

Examples:

grep('-v','GLOBAL_VARIABLE','*.js');grep('GLOBAL_VARIABLE','*.js');

Reads input string from given files and returns a string containing all lines of thefile that match the givenregex_filter.

Available options:

• -n <num>: Show the first<num> lines of the files

Examples:

varstr=head({'-n':1},'file*.txt');varstr=head('file1','file2');varstr=head(['file1','file2']);// same as above

Read the start of a file.

Available options:

• -s: symlink
• -f: force

Examples:

ln('file','newlink');ln('-sf','file','existing');

Links source to dest. Use -f to force the link, should dest already exist.

Available options:

• -R: recursive
• -A: all files (include files beginning with., except for. and..)
• -L: follow symlinks
• -d: list directories themselves, not their contents
• -l: list objects representing each file, each with fields containingls -l output fields. Seefs.Statsfor more info

Examples:

ls('projs/*.js');ls('-R','/users/me','/tmp');ls('-R',['/users/me','/tmp']);// same as abovels('-l','file.txt');// { name: 'file.txt', mode: 33188, nlink: 1, ...}

Returns array of files in the given path, or in current directory if no path provided.

Available options:

• -p: full path (will create intermediate dirs if necessary)

Examples:

mkdir('-p','/tmp/a/b/c/d','/tmp/e/f/g');mkdir('-p',['/tmp/a/b/c/d','/tmp/e/f/g']);// same as above

Creates directories.

Available options:

• -f: force (default behavior)
• -n: no-clobber

Examples:

mv('-n','file','dir/');mv('file1','file2','dir/');mv(['file1','file2'],'dir/');// same as above

Moves files.

Returns the current directory.

Available options:

• -f: force
• -r, -R: recursive

Examples:

rm('-rf','/tmp/*');rm('some_file.txt','another_file.txt');rm(['some_file.txt','another_file.txt']);// same as above

Removes files.

Available options:

• -i: Replace contents of 'file' in-place.Note that no backups will be created!

Examples:

sed('-i','PROGRAM_VERSION','v0.1.3','source.js');sed(/.*DELETE_THIS_LINE.*\n/,'','source.js');

Reads an input string fromfiles and performs a JavaScriptreplace() on the inputusing the given search regex and replacement string or function. Returns the new string after replacement.

Note:

Like unixsed, ShellJSsed supports capture groups. Capture groups are specifiedusing the$n syntax:

sed(/(\w+)\s(\w+)/,'$2, $1','file.txt');

Available options:

• +/-e: exit upon error (config.fatal)
• +/-v: verbose: show all commands (config.verbose)
• +/-f: disable filename expansion (globbing)

Examples:

set('-e');// exit upon first errorset('+e');// this undoes a "set('-e')"

Sets global configuration variables

Available options:

• -r: Reverse the result of comparisons
• -n: Compare according to numerical value

Examples:

sort('foo.txt','bar.txt');sort('-r','foo.txt');

Return the contents of the files, sorted line-by-line. Sorting multiplefiles mixes their content, just like unix sort does.

Available options:

• -n <num>: Show the last<num> lines of the files

Examples:

varstr=tail({'-n':1},'file*.txt');varstr=tail('file1','file2');varstr=tail(['file1','file2']);// same as above

Read the end of a file.

Examples:

vartmp=tempdir();// "/tmp" for most *nix platforms

Searches and returns string containing a writeable, platform-dependent temporary directory.Follows Python'stempfile algorithm.

Available expression primaries:

• '-b', 'path': true if path is a block device
• '-c', 'path': true if path is a character device
• '-d', 'path': true if path is a directory
• '-e', 'path': true if path exists
• '-f', 'path': true if path is a regular file
• '-L', 'path': true if path is a symbolic link
• '-p', 'path': true if path is a pipe (FIFO)
• '-S', 'path': true if path is a socket

Examples:

if(test('-d',path)){/* do something with dir */};if(!test('-f',path))continue;// skip if it's a regular file

Evaluates expression using the available primaries and returns corresponding value.

Examples:

cat('input.txt').to('output.txt');

Analogous to the redirection operator> in Unix, but works withShellStrings (such as those returned bycat,grep, etc).Like Unixredirections,to() will overwrite any existing file!

Examples:

cat('input.txt').toEnd('output.txt');

Analogous to the redirect-and-append operator>> in Unix, but works withShellStrings (such as those returned bycat,grep, etc).

Available options:

• -a: Change only the access time
• -c: Do not create any files
• -m: Change only the modification time
• -d DATE: Parse DATE and use it instead of current time
• -r FILE: Use FILE's times instead of current time

Examples:

touch('source.js');touch('-c','/path/to/some/dir/source.js');touch({'-r':FILE},'/path/to/some/dir/source.js');

Update the access and modification times of each FILE to the current time.A FILE argument that does not exist is created empty, unless -c is supplied.This is a partial implementation oftouch(1).

Available options:

• -i: Ignore case while comparing
• -c: Prefix lines by the number of occurrences
• -d: Only print duplicate lines, one for each group of identical lines

Examples:

uniq('foo.txt');uniq('-i','foo.txt');uniq('-cd','foo.txt','bar.txt');

Filter adjacent matching lines from input

Examples:

varnodeExec=which('node');

Searches forcommand in the system's PATH. On Windows, this uses thePATHEXT variable to append the extension if it's not already executable.Returns string containing the absolute path to the command.

Exits the current process with the given exit code.

Tests if error occurred in the last command. Returns a truthy value if anerror returned and a falsy value otherwise.

Note: do not rely on thereturn value to be an error message. If you need the last error message, usethe.stderr attribute from the last command's return value instead.

Examples:

varfoo=ShellString('hello world');

Turns a regular string into a string-like object similar to what eachcommand returns. This has special methods, like.to() and.toEnd()

Object containing environment variables (both getter and setter). Shortcutto process.env.

Examples:

grep('foo','file1.txt','file2.txt').sed(/o/g,'a').to('output.txt');echo('files with o\'s in the name:\n'+ls().grep('o'));cat('test.js').exec('node');// pipe to exec() call

Commands can send their output to another command in a pipe-like fashion.sed,grep,cat,exec,to, andtoEnd can appear on the right-handside of a pipe. Pipes can be chained.

Example:

varsh=require('shelljs');varsilentState=sh.config.silent;// save old silent statesh.config.silent=true;/* ... */sh.config.silent=silentState;// restore old silent state

Suppresses all command output iftrue, except forecho() calls.Default isfalse.

Example:

require('shelljs/global');config.fatal=true;// or set('-e');cp('this_file_does_not_exist','/dev/null');// throws Error here/* more commands... */

Iftrue the script will throw a Javascript error when any shell.jscommand encounters an error. Default isfalse. This is analogous toBash'sset -e

Example:

config.verbose=true;// or set('-v');cd('dir/');rm('-rf','foo.txt','bar.txt');exec('echo hello');

Will print each command as follows:

cd dir/rm -rf foo.txt bar.txtexec echo hello

Example:

config.globOptions={nodir:true};

Use this value for calls toglob.sync() instead of the default options.

Example:

varshell=require('shelljs');// Make changes to shell.config, and do stuff.../* ... */shell.config.reset();// reset to original state// Do more stuff, but with original settings/* ... */

Reset shell.config to the defaults:

{fatal:false,globOptions:{},maxdepth:255,noglob:false,silent:false,verbose:false,}

Nate Fischer	Brandon Freitag