README
add-to-path
This micro-lib allows you to alter the $PATH
in a cross-platform way.
Main Usage
var path = require('path');
var addToPath = require('add-to-path');
var restorePath = addToPath(path.join(process.cwd(), 'node_modules', '.bin'));
// process.env.PATH now starts with the `.bin` in your `node_modules` directory :-)
// unless you happen to be running on windows, in which case it *might* be process.env.Path :-)
// but you don't have to think about that...
// want to restore the path to what it was before you mucked with it?
// just call the function you get back:
restorePath();
// wanna add several paths at once? Done!
addToPath(['/foo/bar/.bin', '/bar/foo/.bin']);
options
platform
Allows you to specify your own platform. Defaults to process.platform
. Currently the only meaningful value is
'win32'
. This option is mainly available for testing purposes.
append
Defaults to undefined
, but when set to true
will add the directory you pass to the end (rather than the beginning).
Other info
LICENSE -> MIT
Much of the original code for this came from npm/npm