.\" Man page generated from reStructuredText.
.
.TH LIFT 1 "2016-09-25" "2.5.0" "Lift Manual"
.SH NAME
lift \- Run a Lift test suite
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
lift [\fIOPTION\fP]... [\fITEST\fP]...
.SH DESCRIPTION
.sp
The lift command runs all or parts of a Lift test suite.
By default, with no option, \fIlift\fP run all test it discovers in the current
directory and its sub\-directories.
.sp
Lift stands for Lift Integration\-Functional Testing.
.SH OPTIONS
.INDENT 0.0
.TP
.B \fB\-h\fP, \fB\-\-help\fP
Show an help message and exit.
.TP
.B \fB\-V\fP, \fB\-\-version\fP
Show the lift version.
.TP
.B \fB\-q\fP, \fB\-\-quiet\fP
Do not print the output of tests as they run.
.TP
.B \fB\-d\fP, \fB\-\-detailed\-summary\fP
Print the output of failed tests in the final summary.
.TP
.B \fB\-n\fP, \fB\-\-no\-color\fP
Disable colored output.
Maybe useful, for example if colors interfere with your term.
.TP
.B \fB\-\-regex\fP
Process \fITEST\fP strings as standard Python regex.
See below for more information.
.TP
.B \fB\-\-no\-upper\-inheritance\fP
Do not load remotes/environment from upper level \fIlift.yaml\fP files.
By default, lift will look for \fIlift.yaml\fP files in upper level folders in
order to find settings to inherit for the current test file.
This option disable this behaviour and consider the current test directory
as a top level one.
.TP
.B \fB\-\-put\-remotes\-in\-environment\fP
All defined remotes will be passed as environment variables to tests.
Variables will be in the following form:
\fILIFT_REMOTE_remotename=login:password@host\fP\&. Note that the password (along
with the ":" separator) will not be there if it was not defined in the first
place. \fBSECURITY WARNING\fP: Do not use this option if some of your binary
tests can not be trusted to keep these credentials for themselves.
.TP
.B \fB\-f\fP \fIFOLDER\fP, \fB\-\-folder\fP \fIFOLDER\fP
Specify the root folder in which tests will be looked for.
By default, use the current working directory.
.TP
.B \fB\-r\fP \fIREMOTE\fP, \fB\-\-remote\fP \fIREMOTE\fP
Define a remote. The value should be in the following form:
\fIREMOTENAME=USERNAME:PASSWORD@HOST\fP\&. Note that the PASSWORD field (along with
the ":" separator) is optional if SSH keys are properly set. This option can
be used multiple times to define multiple remotes.
Remotes defined via this option supersede those defined via lift.yaml files.
.TP
.B \fB\-\-with\-xunit\fP
Provide test results in the standard XUnit XML format.
.TP
.B \fB\-\-xunit\-file\fP \fIXUNIT_FILE\fP
Specify the path of the XML file to store the XUnit report in.
The default is \fIlift.xml\fP in the current working directory.
.UNINDENT
.SH RUN SPECIFIC TESTS
.sp
You can select specific tests to run directly on the command line.
You can use the test string format as found in the normal lift output,
ie. "FOLDER/TEST_NAME".
.sp
If you set the "\-\-regex" option, expressions will be matched as standard
Python regex. For example, ".*foo" will match all tests containing the
word "foo".
.sp
See \fI\%http://docs.python.org/library/re.html\fP for more information on the Python
regex syntax.
.SH SEE ALSO
.sp
For the test suite definition, see \fBlift.yaml\fP (1)
.SH AUTHOR
Written an maintained by Nicolas Delvaux <contact@nicolas-delvaux.org>
.SH COPYRIGHT
GPL2+
.\" Generated by docutils manpage writer.
.