1BEHAVE(1) User Commands BEHAVE(1)
2
6 behave - Run a number of feature tests with behave.
7
9 usage: behave [options] [ [DIR|FILE|FILE:LINE] ]+
10 Run a number of feature tests with behave.
12 positional arguments:
14 paths Feature directory, file or file location (FILE:LINE).
15 optional arguments:
17 -h, --help
18 show this help message and exit
19 -c, --no-color
21 Disable the use of ANSI color escapes.
22 --color
24 Use ANSI color escapes. This is the default behaviour. This
25 switch is used to override a configuration file setting.
26 -d, --dry-run
28 Invokes formatters without executing the steps.
29 -D NAME=VALUE, --define NAME=VALUE
31 Define user-specific data for the config.userdata dictionary.
32 Example: -D foo=bar to store it in config.userdata["foo"].
33 -e PATTERN, --exclude PATTERN
35 Don't run feature files matching regular expression PATTERN.
36 -i PATTERN, --include PATTERN
38 Only run feature files matching regular expression PATTERN.
39 --no-junit
41 Don't output JUnit-compatible reports.
42 --junit
44 Output JUnit-compatible reports. When junit is enabled, all std‐
45 out and stderr will be redirected and dumped to the junit
46 report, regardless of the "-- capture" and "--no-capture"
47 options.
48 --junit-directory PATH
50 Directory in which to store JUnit reports.
51 -f FORMAT, --format FORMAT
53 Specify a formatter. If none is specified the default formatter
54 is used. Pass "--format help" to get a list of available format‐
55 ters.
56 --steps-catalog
58 Show a catalog of all available step definitions. SAME AS:
59 --format=steps.catalog --dry-run --no-summary -q
60 -k, --no-skipped
62 Don't print skipped steps (due to tags).
63 --show-skipped
65 Print skipped steps. This is the default behaviour. This switch
66 is used to override a configuration file setting.
67 --no-snippets
69 Don't print snippets for unimplemented steps.
70 --snippets
72 Print snippets for unimplemented steps. This is the default be‐
73 haviour. This switch is used to override a configuration file
74 setting.
75 -m, --no-multiline
77 Don't print multiline strings and tables under steps.
78 --multiline
80 Print multiline strings and tables under steps. This is the
81 default behaviour. This switch is used to override a configura‐
82 tion file setting.
83 -n NAME, --name NAME
85 Only execute the feature elements which match part of the given
86 name. If this option is given more than once, it will match
87 against all the given names.
88 --no-capture
90 Don't capture stdout (any stdout output will be printed immedi‐
91 ately.)
92 --capture
94 Capture stdout (any stdout output will be printed if there is a
95 failure.) This is the default behaviour. This switch is used to
96 override a configuration file setting.
97 --no-capture-stderr
99 Don't capture stderr (any stderr output will be printed immedi‐
100 ately.)
101 --capture-stderr
103 Capture stderr (any stderr output will be printed if there is a
104 failure.) This is the default behaviour. This switch is used to
105 override a configuration file setting.
106 --no-logcapture
108 Don't capture logging. Logging configuration will be left
109 intact.
110 --logcapture
112 Capture logging. All logging during a step will be captured and
113 displayed in the event of a failure. This is the default behav‐
114 iour. This switch is used to override a configuration file set‐
115 ting.
116 --logging-level LOGGING_LEVEL
118 Specify a level to capture logging at. The default is INFO -
119 capturing everything.
120 --logging-format LOGGING_FORMAT
122 Specify custom format to print statements. Uses the same format
123 as used by standard logging handlers. The default is "%(level‐
124 name)s:%(name)s:%(message)s".
125 --logging-datefmt LOGGING_DATEFMT
127 Specify custom date/time format to print statements. Uses the
128 same format as used by standard logging handlers.
129 --logging-filter LOGGING_FILTER
131 Specify which statements to filter in/out. By default, every‐
132 thing is captured. If the output is too verbose, use this option
133 to filter out needless output. Example: --logging-filter=foo
134 will capture statements issued ONLY to foo or foo.what.ever.sub
135 but not foobar or other logger. Specify multiple loggers with
136 comma: filter=foo,bar,baz. If any logger name is prefixed with a
137 minus, eg filter=-foo, it will be excluded rather than included.
138 --logging-clear-handlers
140 Clear all other logging handlers.
141 --no-summary
143 Don't display the summary at the end of the run.
144 --summary
146 Display the summary at the end of the run.
147 -o FILE, --outfile FILE
149 Write to specified file instead of stdout.
150 -q, --quiet
152 Alias for --no-snippets --no-source.
153 -s, --no-source
155 Don't print the file and line of the step definition with the
156 steps.
157 --show-source
159 Print the file and line of the step definition with the steps.
160 This is the default behaviour. This switch is used to override a
161 configuration file setting.
162 --stage STAGE
164 Defines the current test stage. The test stage name is used as
165 name prefix for the environment file and the steps directory
166 (instead of default path names).
167 --stop Stop running tests at the first failure.
169 -t TAG_EXPRESSION, --tags TAG_EXPRESSION
171 Only execute features or scenarios with tags matching
172 TAG_EXPRESSION. Pass "--tags-help" for more information.
173 -T, --no-timings
175 Don't print the time taken for each step.
176 --show-timings
178 Print the time taken, in seconds, of each step after the step
179 has completed. This is the default behaviour. This switch is
180 used to override a configuration file setting.
181 -v, --verbose
183 Show the files and features loaded.
184 -w, --wip
186 Only run scenarios tagged with "wip". Additionally: use the
187 "plain" formatter, do not capture stdout or logging output and
188 stop at the first failure.
189 -x, --expand
191 Expand scenario outline tables in output.
192 --lang LANG
194 Use keywords for a language other than English.
195 --lang-list
197 List the languages available for --lang.
198 --lang-help LANG
200 List the translations accepted for one language.
201 --tags-help
203 Show help for tag expressions.
204 --version
206 Show version.
207behave 1.2.6 January 2020 BEHAVE(1)