virtualenv - Python virtual environment creator
virtualenv [options...] dest
The virtualenv utility creates virtual Python instances, each
invokable with its own Python executable. Each instance can have different
sets of modules, installable via easy_install. Virtual Python instances can
also be created without root access.
- --version
- display the version of the virtualenv package and it's location, then
exit
- --with-traceback
- on failure also display the stacktrace internals of virtualenv (default:
False)
- --read-only-app-data
- use app data folder in read-only mode (write operations will fail with
error) (default: False)
- --app-data
APP_DATA
- a data folder used as cache by the virtualenv (default:
~/.local/share/virtualenv)
- --reset-app-data
- start with empty app data folder (default: False)
- --upgrade-embed-wheels
- trigger a manual update of the embedded wheels (default: False)
- -h, --help
- show help and exit
- verbosity = verbose - quiet, default INFO,
mapping => CRITICAL=0, ERROR=1,
WARNING=2, INFO=3, DEBUG=4,
NOTSET=5
- -v, --verbose
- increase verbosity (default: 2)
- -q, --quiet
- decrease verbosity (default: 0)
- discover and provide a target interpreter
- --discovery
{builtin}
- interpreter discovery method (default: builtin)
- -p py, --python
py
- target interpreter for which to create a virtual (either absolute path or
identifier string) (default: /usr/bin/python3)
- --try-first-with
py_exe
- try first these interpreters before starting the discovery (default:
[])
- options for creator builtin
- --creator
{builtin,cpython3-posix,venv}
- create environment via (builtin = cpython3-posix) (default:
builtin)
- dest
- directory to create virtualenv at
- --clear
- remove the destination directory if exist before starting (will overwrite
files otherwise) (default: False)
- --no-vcs-ignore
- don't create VCS ignore directive in the destination directory (default:
False)
- --system-site-packages
- give the virtual environment access to the system site-packages dir
(default: False)
- --symlinks
- try to use symlinks rather than copies, when symlinks are not the default
for the platform (default: True)
- --copies,
--always-copy
- try to use copies rather than symlinks, even when symlinks are the default
for the platform (default: False)
- options for seeder app-data
- --seeder
{app-data,pip}
- seed packages install method (default: app-data)
- --no-seed,
--without-pip
- do not install seed packages (default: False)
- --download
- pass to enable download of the latest pip, setuptools, and wheel from PyPI
(default: False)
- --no-download,
--never-download
- pass to disable download of the latest pip, setuptools, and wheel from
PyPI (default: True)
- a path containing wheels the seeder may also use beside bundled (can be
set 1+ times) (default: [])
- --pip
version
- pip version to install, bundle for bundled (default: latest)
- --setuptools
version
- setuptools version to install, bundle for bundled (default: latest)
- --wheel
version
- wheel version to install, bundle for bundled (default: latest)
- --no-pip
- do not install pip (default: False)
- --no-setuptools
- do not install setuptools (default: False)
- --no-wheel
- do not install wheel (default: False)
- --no-periodic-update
- disable the periodic (once every 14 days) update of the embedded wheels
(default: True)
- --symlink-app-data
- symlink the python packages from the app-data folder (requires seed
pip>=19.3) (default: False)
- options for activation scripts
- --activators
comma_sep_list
- activators to generate - default is all supported (default:
bash,cshell,fish,powershell,python,xonsh)
- --prompt
prompt
- provides an alternative prompt prefix for this environment (default:
None)
config file $HOME/.config/virtualenv/virtualenv.ini (change
via env var VIRTUALENV_CONFIG_FILE)
This man-page was created using help2man and then updated by Scott
Kitterman <scott@kitterman.com> and is licensed under the same terms
as virtualenv.