Description

Node.js virtual environment =========================== ``nodeenv`` (node.js virtual environment) is a tool to create isolated node.js environments. It creates an environment that has its own installation directories, that doesn't share libraries with other node.js virtual environments. Also the new environment can be integrated with the environment which was built by virtualenv_ (python). If you use nodeenv feel free to add your project on wiki: `Who-Uses-Nodeenv`_. .. _Who-Uses-Nodeenv: https://github.com/ekalinin/nodeenv/wiki/Who-Uses-Nodeenv .. image:: https://github.com/ekalinin/nodeenv/actions/workflows/main.yml/badge.svg?branch=master :target: https://github.com/ekalinin/nodeenv/actions/workflows/main.yml :alt: CI .. contents:: :local: Install ------- Global installation ^^^^^^^^^^^^^^^^^^^ You can install nodeenv globally with `easy_install`_:: $ sudo easy_install nodeenv or with `pip`_:: $ sudo pip install nodeenv or on Debian using `dpkg`_:: $ ln -s debian-upstream debian $ dpkg-buildpackage -uc -us -b $ sudo dpkg -i $(ls -1rt ../nodeenv_*.deb | tail -n1) .. _dpkg: https://www.debian.org/doc/manuals/debian-faq/ch-pkgtools.en.html Local installation ^^^^^^^^^^^^^^^^^^ If you're using virtualenv_ then you can install nodeenv via pip_/easy_install_ inside any virtual environment built with virtualenv:: $ virtualenv env $ . env/bin/activate (env) $ pip install nodeenv (env) $ nodeenv --version 0.6.5 If you want to work with the latest version of the nodeenv you can install it from the github `repository`_:: $ git clone https://github.com/ekalinin/nodeenv.git $ ./nodeenv/nodeenv.py --help or with `pip`_:: $ pip install -e git+https://github.com/ekalinin/nodeenv.git#egg=nodeenv .. _repository: https://github.com/ekalinin/nodeenv .. _pip: http://pypi.python.org/pypi/pip .. _easy_install: http://pypi.python.org/pypi/setuptools Dependency ---------- For nodeenv ^^^^^^^^^^^ * python (2.6+, 3.5+, or pypy) * make * tail For node.js ^^^^^^^^^^^ * libssl-dev Usage ----- Basic ^^^^^ Create new environment:: $ nodeenv env Activate new environment:: $ . env/bin/activate Check versions of main packages:: (env) $ node -v v0.10.26 (env) $ npm -v 1.4.3 Deactivate environment:: (env) $ deactivate_node Advanced ^^^^^^^^ Get available node.js versions:: $ nodeenv --list 0.0.1 0.0.2 0.0.3 0.0.4 0.0.5 0.0.6 0.1.0 0.1.2 0.1.3 0.1.4 0.1.5 0.1.6 0.1.7 0.1.8 0.1.10 0.1.11 0.1.12 0.1.13 0.1.14 0.1.15 0.1.16 0.1.18 0.1.19 0.1.20 0.1.21 0.1.22 0.1.23 0.1.24 0.1.26 0.1.27 0.1.28 0.1.29 0.1.30 0.1.31 0.1.32 0.1.90 0.1.91 0.1.92 0.1.93 0.1.94 0.1.95 0.1.96 0.1.98 0.1.99 0.1.100 0.1.101 0.1.102 0.1.103 0.1.104 0.2.1 0.2.2 0.2.3 0.2.4 0.2.5 0.2.6 0.3.0 0.3.2 0.3.3 0.3.4 0.3.5 0.3.6 0.3.7 0.3.8 0.4.1 0.4.2 0.4.3 0.4.4 0.4.5 0.4.6 Install node.js "0.4.3" without ssl support with 4 parallel commands for compilation and npm.js "0.3.17":: $ nodeenv --without-ssl --node=0.4.3 --npm=0.3.17 --with-npm --jobs=4 env-4.3 Install node.js from the source:: $ nodeenv --node=0.10.25 --source env-0.10.25 Install node.js from a mirror:: $ nodeenv --node=10.19.0 --mirror=https://npm.taobao.org/mirrors/node It's much faster to install from the prebuilt package than Install & compile node.js from source:: $ time nodeenv --node=0.10.25 --prebuilt env-0.10.25-prebuilt + Install node.js (0.10.25) ... done. real 0m6.928s user 0m0.408s sys 0m1.144s $ time nodeenv --node=0.10.25 --source env-0.10.25-src + Install node.js (0.10.25) ... done. real 4m12.602s user 6m34.112s sys 0m30.524s Create a new environment with the system-wide node.js:: $ nodeenv --node=system Saving the versions of all installed packages to a file:: $ . env-4.3/bin/activate (env-4.3)$ npm install -g express (env-4.3)$ npm install -g jade (env-4.3)$ freeze ../prod-requirements.txt If you want to list locally installed packages use ``-l`` option:: (env-4.3)$ freeze -l ../prod-requirements.txt Create an environment from a requirements file:: $ nodeenv --requirements=../prod-requirements.txt --jobs=4 env-copy Requirements files are plain text files that contain a list of packages to be installed. These text files allow you to create repeatable installations. Requirements file example:: $ cat ../prod-requirements.txt connect@1.3.0 express@2.2.2 jade@0.10.4 mime@1.2.1 npm@0.3.17 qs@0.0.7 If you already have the python virtualenv tool, and want to use nodeenv and virtualenv in conjunction, then you should create (or activate) the python virtual environment:: # in case of using virtualenv_wrapper $ mkvirtualenv my_env # in case of using virtualenv $ . my_env/bin/activate and