Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wbyoung/avn

Automatic Version Switching for Node
https://github.com/wbyoung/avn

Last synced: 3 months ago
JSON representation

Automatic Version Switching for Node

Awesome Lists containing this project

README 

        
# avn



[![NPM version][npm-image]][npm-url] [![Build status][travis-image]][travis-url] [![Code Climate][codeclimate-image]][codeclimate-url] [![Coverage Status][coverage-image]][coverage-url] [![Dependencies][david-image]][david-url] [![devDependencies][david-dev-image]][david-dev-url]



Automatic Version Switching for Node.js



## Install



``` bash

npm install -g avn avn-nvm avn-n

avn setup

```



Now when you `cd` into a directory with a `.node-version` file, `avn` will

automatically detect the change and use your installed version manager to

switch to that version of node. What goes in your `.node-version` file? A

[semver][semver] version number corresponding to the version of Node.js that

your project uses.



## Plugins



`avn` supports the following version managers:



 - [`nvm`][nvm] via [`avn-nvm`][avn-nvm]

 - [`n`][n] via [`avn-n`][avn-n]

 - [`nodebrew`][nodebrew] via [`avn-nodebrew`][avn-nodebrew]



We don't recommend using all of these tools to manage your versions of node, but feel

free to install all of them. They won't conflict with each other.



## io.js



Plugins support a consistent syntax in the `.node-version` file for specifying

the use of [io.js][io.js] rather than node. Simply add an `iojs` prefix. For

instance: `iojs-1.4` or `iojs-v1.4`.



## Todo List



 * Support switching back to the previous version of node that you were using

   when you leave a directory.



Pull requests are welcome!



## Troubleshooting



If you're having a problem, please `cd` to the directory where your

`.node-version` file is stored and run (note the double-underscore prefix):



```bash

__avn_debug

```



The [contributing page][contributing] has details about where to report your issue based on the version manager you use.



Also note that the `avn setup` command will only work with the version of node

with which you installed it. If you install and then switch your node version,

you'll get an error that `avn` can't be found. This is okay, but if you need to

run the setup command again, simply `npm install -g avn` to get a new copy for

your current node version.



## Updating



Simply reinstall via npm & re-run the setup:



```bash

npm install -g avn avn-nvm avn-n

avn setup

```



## License



This project is distributed under the MIT license.



[travis-image]: http://img.shields.io/travis/wbyoung/avn.svg?style=flat

[travis-url]: http://travis-ci.org/wbyoung/avn

[npm-image]: http://img.shields.io/npm/v/avn.svg?style=flat

[npm-url]: https://npmjs.org/package/avn

[codeclimate-image]: http://img.shields.io/codeclimate/github/wbyoung/avn.svg?style=flat

[codeclimate-url]: https://codeclimate.com/github/wbyoung/avn

[coverage-image]: http://img.shields.io/coveralls/wbyoung/avn.svg?style=flat

[coverage-url]: https://coveralls.io/r/wbyoung/avn

[david-image]: http://img.shields.io/david/wbyoung/avn.svg?style=flat

[david-url]: https://david-dm.org/wbyoung/avn

[david-dev-image]: http://img.shields.io/david/dev/wbyoung/avn.svg?style=flat

[david-dev-url]: https://david-dm.org/wbyoung/avn#info=devDependencies



[contributing]: https://github.com/wbyoung/avn/blob/master/CONTRIBUTING.md

[nvm]: https://github.com/creationix/nvm

[n]: https://github.com/visionmedia/n

[nodebrew]: https://github.com/hokaccha/nodebrew

[avn-nvm]: https://github.com/wbyoung/avn-nvm

[avn-n]: https://github.com/wbyoung/avn-n

[avn-nodebrew]: https://github.com/kuy/avn-nodebrew

[io.js]: https://iojs.org/

[semver]: http://semver.org/



## Uninstall 

```bash

npm rm -g avn; rm -r ~/.avn

```