.\" This file was generated by help2man 1.47.8 but then modified manually
.\"  https://github.com/tox-dev/tox/issues/1409
.TH TOX "1" "August 2019" "Debian" "tox Documentation"
.SH NAME
tox \- virtualenv-based automation of test activities
.SH SYNOPSIS
\fBtox\fP [\fIoptions\fP] [\fIargs\fP ...]
.SH DESCRIPTION
.sp
tox is a generic \fI\%virtualenv\fP management and test command line tool you can use for:
.IP \(bu 2
checking your package installs correctly with different Python versions and
interpreters
.IP \(bu 2
running your tests in each of the environments, configuring your test tool of choice
.IP \(bu 2
acting as a frontend to Continuous Integration servers, greatly
reducing boilerplate and merging CI and shell\-based testing.
.SH OPTIONS
.PP
.SS "positional arguments:"
.TP
args
additional arguments available to command positional substitution (default: None)
.SS "optional arguments:"
.TP
\fB\-\-version\fR
report version information to stdout. (default: False)
.TP
\fB\-h\fR, \fB\-\-help\fR
show help about options (default: False)
.TP
\fB\-\-help\-ini\fR, \fB\-\-hi\fR
show help about ini\-names (default: False)
.TP
\fB\-v\fR
increase verbosity of reporting output.\-vv mode turns off output redirection for package installation, above level two verbosity flags are passed through
to pip (with two less level) (default: 0)
.TP
\fB\-q\fR
progressively silence reporting output. (default: 0)
.TP
\fB\-\-showconfig\fR
show configuration information for all environments. (default: False)
.TP
\fB\-l\fR, \fB\-\-listenvs\fR
show list of test environments (with description if verbose) (default: False)
.TP
\fB\-a\fR, \fB\-\-listenvs\-all\fR
show list of all defined environments (with description if verbose) (default: False)
.TP
\fB\-c\fR CONFIGFILE
config file name or directory with 'tox.ini' file. (default: None)
.TP
\fB\-e\fR envlist
work against specified environments (ALL selects all). (default: None)
.TP
\fB\-\-notest\fR
skip invoking test commands. (default: False)
.TP
\fB\-\-sdistonly\fR
only perform the sdist packaging activity. (default: False)
.TP
\fB\-p\fR VAL, \fB\-\-parallel\fR VAL
run tox environments in parallel, the argument controls limit: all, auto \- cpu count, some positive number, zero is turn off (default: 0)
.TP
\fB\-o\fR, \fB\-\-parallel\-live\fR
connect to stdout while running environments (default: False)
.TP
\fB\-\-parallel\-\-safe\-build\fR
(deprecated) ensure two tox builds can run in parallel (uses a lock file in the tox workdir with .lock extension) (default: False)
.TP
\fB\-\-installpkg\fR PATH
use specified package for installation into venv, instead of creating an sdist. (default: None)
.TP
\fB\-\-develop\fR
install package in the venv using 'setup.py develop' via 'pip \fB\-e\fR .' (default: False)
.TP
\fB\-i\fR URL, \fB\-\-index\-url\fR URL
set indexserver url (if URL is of form name=url set the url for the 'name' indexserver, specifically) (default: None)
.TP
\fB\-\-pre\fR
install pre\-releases and development versions of dependencies. This will pass the \fB\-\-pre\fR option to install_command (pip by default). (default: False)
.TP
\fB\-r\fR, \fB\-\-recreate\fR
force recreation of virtual environments (default: False)
.TP
\fB\-\-result\-json\fR PATH
write a json file with detailed information about all commands and results involved. (default: None)
.TP
\fB\-\-hashseed\fR SEED
set PYTHONHASHSEED to SEED before running commands. Defaults to a random integer in the range [1, 4294967295] ([1, 1024] on Windows). Passing 'noset'
suppresses this behavior. (default: None)
.TP
\fB\-\-force\-dep\fR REQ
Forces a certain version of one of the dependencies when configuring the virtual environment. REQ Examples 'pytest<2.7' or 'django>=1.6'. (default: None)
.TP
\fB\-\-sitepackages\fR
override sitepackages setting to True in all envs (default: False)
.TP
\fB\-\-alwayscopy\fR
override alwayscopy setting to True in all envs (default: False)
.TP
\fB\-s\fR [val], \fB\-\-skip\-missing\-interpreters\fR [val]
don't fail tests for missing interpreters: {config,true,false} choice (default: config)
.TP
\fB\-\-workdir\fR PATH
tox working directory (default: None)
.SH ENVIRONMENT VARIABLES
.PP
.PP
\fBTOXENV\fR
comma separated list of environments (overridable by '\-e')
.PP
\fBTOX_SKIP_ENV\fR
regular expression to filter down from running tox environments
.PP
\fBTOX_TESTENV_PASSENV\fR
space\-separated list of extra environment variables to be passed into test command environments
.PP
\fBPY_COLORS\fR
0 disable colorized output, 1 enable (default)
.SH "SEE ALSO"
\fBtox-quickstart\fR(1)