# ShellJS - Unix shell commands for Node.js [](http://travis-ci.org/arturadib/shelljs)
# ShellJS - Unix shell commands for Node.js [](http://travis-ci.org/arturadib/shelljs)
+ _This project is young and experimental. Use at your own risk._
ShellJS is a portable **(Windows/Linux/OS X)** implementation of Unix shell commands on top of the Node.js API. You can use it to eliminate your shell script's dependency on Unix while still keeping its familiar and powerful commands. You can also install it globally so you can run it from outside Node projects - say goodbye to those gnarly Bash scripts!
+ _Major API change as of v0.0.4: `ls()` and `find()` now return arrays._
ShellJS is a **portable** (Windows included) implementation of Unix shell commands on top of the Node.js API. You can use it to eliminate your shell script's dependency on Unix while still keeping its familiar and powerful commands.
The project is [unit-tested](http://travis-ci.org/arturadib/shelljs) and battled-tested in projects like:
The project is [unit-tested](http://travis-ci.org/arturadib/shelljs) and is being used at Mozilla's [pdf.js](http://github.com/mozilla/pdf.js).
+ [PDF.js](http://github.com/mozilla/pdf.js) - Firefox's next-gen PDF reader
sed '-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, cat 'macro.js', file
cd '..'
# Run external tool synchronously
if (exec 'git commit -am "Auto-commit"').code != 0
echo 'Error: Git commit failed'
exit 1
```
## Global vs. Local
The example above uses the convenience script `shelljs/global` to reduce verbosity. If polluting your global namespace is not desirable, simply require `shelljs`.
The example above uses the convenience script `shelljs/global` to reduce verbosity. If polluting your global namespace is not desirable, simply require `shelljs`.
@ -44,55 +100,37 @@ var shell = require('shelljs');
shell.echo('hello world');
shell.echo('hello world');
```
```
### Make tool
## Make tool
A convenience script `shelljs/make` is also provided to mimic the behavior of a Unix Makefile. In this case all shell objects are global, and command line arguments will cause the script to execute only the corresponding function in the global `target` object. To avoid redundant calls, target functions are executed only once per script.
A convenience script `shelljs/make` is also provided to mimic the behavior of a Unix Makefile. In this case all shell objects are global, and command line arguments will cause the script to execute only the corresponding function in the global `target` object. To avoid redundant calls, target functions are executed only once per script.
Example:
Example (CoffeeScript):
```javascript
```coffeescript
//
require 'shelljs/make'
// Example file: make.js
//
target.all = ->
require('shelljs/make');
target.bundle()
target.docs()
target.all = function() {
target.bundle();
target.bundle = ->
target.docs();
cd __dirname
}
mkdir 'build'
cd 'lib'
// Bundle JS files
(cat '*.js').to '../build/output.js'
target.bundle = function() {
cd(__dirname);
target.docs = ->
mkdir('build');
cd __dirname
cd('lib');
mkdir 'docs'
cat('*.js').to('../build/output.js');
cd 'lib'
}
for file in ls '*.js'
text = grep '//@', file # extract special comments
// Generate docs
text.replace '//@', '' # remove comment tags
target.docs = function() {
text.to 'docs/my_docs.md'
cd(__dirname);
mkdir('docs');
cd('lib');
ls('*.js').forEach(function(file){
var text = grep('//@', file); // extract special comments
text.replace('//@', ''); // remove comment tags
text.to('docs/my_docs.md');
});
}
```
```
To run the target `all`, call the above script without arguments: `$ node make`. To run the target `docs`: `$ node make docs`, and so on.
To run the target `all`, call the above script without arguments: `$ node make`. To run the target `docs`: `$ node make docs`, and so on.
### Installing
Via npm:
```bash
$ npm install shelljs
```
Or simply copy `shell.js` into your project's directory, and `require()` accordingly.
<!--
<!--
@ -102,24 +140,24 @@ Or simply copy `shell.js` into your project's directory, and `require()` accordi
-->
-->
# Command reference
## Command reference
All commands run synchronously, unless otherwise stated.
All commands run synchronously, unless otherwise stated.
#### cd('dir')
### cd('dir')
Changes to directory `dir` for the duration of the script
Changes to directory `dir` for the duration of the script
#### pwd()
### pwd()
Returns the current directory.
Returns the current directory.
#### ls([options ,] path [,path ...])
### ls([options ,] path [,path ...])
#### ls([options ,] path_array)
### ls([options ,] path_array)
Available options:
Available options:
+ `-R`: recursive
+ `-R`: recursive
+ `-a`: all files (include files beginning with `.`)
+ `-A`: all files (include files beginning with `.`, except for `.` and `..`)
Examples:
Examples:
@ -131,8 +169,8 @@ ls('-R', ['/users/me', '/tmp']); // same as above
Returns array of files in the given path, or in current directory if no path provided.
Returns array of files in the given path, or in current directory if no path provided.
#### find(path [,path ...])
### find(path [,path ...])
#### find(path_array)
### find(path_array)
Examples:
Examples:
```javascript
```javascript
@ -146,8 +184,8 @@ Returns array of all files (however deep) in the given paths.
The main difference from `ls('-R', path)` is that the resulting file names
The main difference from `ls('-R', path)` is that the resulting file names
include the base directories, e.g. `lib/resources/file1` instead of just `file1`.
include the base directories, e.g. `lib/resources/file1` instead of just `file1`.
#### cp('[options ,] source [,source ...], dest')
### cp([options ,] source [,source ...], dest)
#### cp('[options ,] source_array, dest')
### cp([options ,] source_array, dest)
Available options:
Available options:
+ `-f`: force
+ `-f`: force
@ -163,8 +201,8 @@ cp('-Rf', ['/tmp/*', '/usr/local/*'], '/home/tmp'); // same as above
Copies files. The wildcard `*` is accepted.
Copies files. The wildcard `*` is accepted.
#### rm([options ,] file [, file ...])
### rm([options ,] file [, file ...])
#### rm([options ,] file_array)
### rm([options ,] file_array)
Available options:
Available options:
+ `-f`: force
+ `-f`: force
@ -180,8 +218,8 @@ rm(['some_file.txt', 'another_file.txt']); // same as above
Removes files. The wildcard `*` is accepted.
Removes files. The wildcard `*` is accepted.
#### mv(source [, source ...], dest')
### mv(source [, source ...], dest')
#### mv(source_array, dest')
### mv(source_array, dest')
Available options:
Available options:
+ `f`: force
+ `f`: force
@ -196,8 +234,8 @@ mv(['file1', 'file2'], 'dir/'); // same as above
Moves files. The wildcard `*` is accepted.
Moves files. The wildcard `*` is accepted.
#### mkdir([options ,] dir [, dir ...])
### mkdir([options ,] dir [, dir ...])
#### mkdir([options ,] dir_array)
### mkdir([options ,] dir_array)
Available options:
Available options:
+ `p`: full path (will create intermediate dirs if necessary)
+ `p`: full path (will create intermediate dirs if necessary)
@ -211,11 +249,17 @@ mkdir('-p', ['/tmp/a/b/c/d', '/tmp/e/f/g']); // same as above
Creates directories.
Creates directories.
#### test(expression)
### test(expression)
Available expression primaries:
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
+ `'-d', 'path'`: true if path is a directory
+ `'-e', 'path'`: true if path exists
+ `'-f', 'path'`: true if path is a regular file
+ `'-f', 'path'`: true if path is a regular file
+ `'-L', 'path'`: true if path is a symboilc link
+ `'-p', 'path'`: true if path is a pipe (FIFO)
+ `'-S', 'path'`: true if path is a socket
Examples:
Examples:
@ -226,8 +270,8 @@ if (!test('-f', path)) continue; // skip if it's a regular file
Evaluates expression using the available primaries and returns corresponding value.
Evaluates expression using the available primaries and returns corresponding value.
#### cat(file [, file ...])
### cat(file [, file ...])
#### cat(file_array)
### cat(file_array)
Examples:
Examples:
@ -241,7 +285,7 @@ Returns a string containing the given file, or a concatenated string
containing the files if more than one file is given (a new line character is
containing the files if more than one file is given (a new line character is
introduced between each file). Wildcard `*` accepted.
introduced between each file). Wildcard `*` accepted.
+ `-v`: Inverse the sense of the regex and print the lines not matching the criteria.
Examples:
Examples:
```javascript
```javascript
grep('-v', 'GLOBAL_VARIABLE', '*.js');
grep('GLOBAL_VARIABLE', '*.js');
grep('GLOBAL_VARIABLE', '*.js');
```
```
Reads input string from given files and returns a string containing all lines of the
Reads input string from given files and returns a string containing all lines of the
file that match the given `regex_filter`. Wildcard `*` accepted.
file that match the given `regex_filter`. Wildcard `*` accepted.
#### which(command)
### which(command)
Examples:
Examples:
@ -290,7 +338,7 @@ var nodeExec = which('node');
Searches for `command` in the system's PATH. On Windows looks for `.exe`, `.cmd`, and `.bat` extensions.
Searches for `command` in the system's PATH. On Windows looks for `.exe`, `.cmd`, and `.bat` extensions.
Returns string containing the absolute path to the command.
Returns string containing the absolute path to the command.
#### echo(string [,string ...])
### echo(string [,string ...])
Examples:
Examples:
@ -302,69 +350,163 @@ var str = echo('hello world');
Prints string to stdout, and returns string with additional utility methods
Prints string to stdout, and returns string with additional utility methods
like `.to()`.
like `.to()`.
#### exit(code)
### dirs([options | '+N' | '-N'])
Available options:
+ `-c`: Clears the directory stack by deleting all of the elements.
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
### pushd([options,] [dir | '-N' | '+N'])
Available options:
+ `-n`: Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated.
Arguments:
+ `dir`: Makes the current working directory be the top of the stack, and then executes the equivalent of `cd 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:
```javascript
// process.cwd() === '/usr'
pushd('/etc'); // Returns /etc /usr
pushd('+1'); // Returns /usr /etc
```
Save the current directory on the top of the directory stack and then cd to `dir`. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
### popd([options,] ['-N' | '+N'])
Available options:
+ `-n`: Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated.
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:
```javascript
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.
### exit(code)
Exits the current process with the given exit code.
Exits the current process with the given exit code.
#### env['VAR_NAME']
### env['VAR_NAME']
Object containing environment variables (both getter and setter). Shortcut to process.env.
Object containing environment variables (both getter and setter). Shortcut to process.env.
Yury Delendik
12 years ago