tree: 495a41ca5e61c4967ef5772e05e8f2eb9b2e988c [path history] [tgz]
  1. test/
  2. .npmignore
  3. .travis.yml
  4. index.js
  5. LICENSE
  6. package.json
  7. README.md
csrc/node-v0.10.24/deps/npm/node_modules/cmd-shim/README.md

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 Dependency Status

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.

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:

function cmdShimIfExists (from, to, cb) {
  fs.stat(from, function (er) {
    if (er) return cb()
    cmdShim(from, to, cb)
  })
}