diff options
Diffstat (limited to 'deps/node/deps/npm/node_modules/cmd-shim/README.md')
-rw-r--r-- | deps/node/deps/npm/node_modules/cmd-shim/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/deps/node/deps/npm/node_modules/cmd-shim/README.md b/deps/node/deps/npm/node_modules/cmd-shim/README.md new file mode 100644 index 00000000..ff6745f8 --- /dev/null +++ b/deps/node/deps/npm/node_modules/cmd-shim/README.md @@ -0,0 +1,44 @@ +# cmd-shim + +The cmd-shim used in npm to create executable scripts on Windows, +since symlinks are not suitable for this purpose there. + +On Unix systems, you should use a symbolic link instead. + +[![Build Status](https://img.shields.io/travis/ForbesLindesay/cmd-shim/master.svg)](https://travis-ci.org/ForbesLindesay/cmd-shim) +[![Dependency Status](https://img.shields.io/david/ForbesLindesay/cmd-shim.svg)](https://david-dm.org/ForbesLindesay/cmd-shim) +[![NPM version](https://img.shields.io/npm/v/cmd-shim.svg)](https://www.npmjs.com/package/cmd-shim) + +## Installation + +``` +npm install cmd-shim +``` + +## API + +### cmdShim(from, to, cb) + +Create a cmd shim at `to` for the command line program at `from`. +e.g. + +```javascript +var cmdShim = require('cmd-shim'); +cmdShim(__dirname + '/cli.js', '/usr/bin/command-name', function (err) { + if (err) throw err; +}); +``` + +### cmdShim.ifExists(from, to, cb) + +The same as above, but will just continue if the file does not exist. +Source: + +```javascript +function cmdShimIfExists (from, to, cb) { + fs.stat(from, function (er) { + if (er) return cb() + cmdShim(from, to, cb) + }) +} +``` |