build-options.md

Option	Default	Description
-c, --config FILE	-	Path to configuration file.
--capture [fd|no|sys|tee-sys]	fd	Per task capturing method.
--clean-lockfile	false	Rewrite the lockfile with only currently collected tasks.
--database-url TEXT	-	Url to the database.
--debug-pytask	false	Trace all function calls in the plugin framework.
--disable-warnings	false	Disables the summary for warnings.
--dry-run	false	Perform a dry-run.
--editor-url-scheme TEXT	file	Use file, vscode, pycharm or a custom url scheme to add URLs to task ids to quickly jump to the task definition. Use no_link to disable URLs.
--explain	false	Explain why tasks need to be executed by showing what changed.
-f, --force	false	Execute a task even if it succeeded successfully before.
--hook-module TEXT	-	Path to a Python module that contains hook implementations.
--ignore TEXT	-	A pattern to ignore files or directories. Refer to 'pathlib.Path.match' for more info.
-k EXPRESSION	-	Select tasks via expressions on task ids.
--log-cli / --no-log-cli	--no-log-cli	Enable live log display during task execution.
--log-cli-date-format TEXT	-	Log date format used by the logging module for live logs.
--log-cli-format TEXT	-	Log format used by the logging module for live logs.
--log-cli-level LEVEL	-	CLI logging level.
--log-date-format TEXT	%H:%M:%S	Log date format used by the logging module.
--log-file TEXT	-	Path to a file where logging will be written.
--log-file-date-format TEXT	-	Log date format used by the logging module for the log file.
--log-file-format TEXT	-	Log format used by the logging module for the log file.
--log-file-level LEVEL	-	Log file logging level.
--log-file-mode [w|a]	w	Log file open mode.
--log-format TEXT	%(levelname)-8s %(name)s:%(filename)s:%(lineno)d %(message)s	Log format used by the logging module.
--log-level LEVEL	-	Level of messages to catch/display. Not set by default, so it depends on the logger configuration.
-m MARKER_EXPRESSION	-	Select tasks via marker expressions.
--max-failures FLOAT RANGE	inf	Stop after some failures.
--n-entries-in-table INTEGER RANGE	15	How many entries to display in the table during the execution. Tasks which are running are always displayed.
--pdb	false	Start the interactive debugger on errors.
--pdbcls module_name:class_name	-	Start a custom debugger on errors. For example: --pdbcls=IPython.terminal.debugger:TerminalPdb
-s	false	Shortcut for --capture=no.
--show-capture [no|stdout|stderr|log|all]	all	Choose which captured output should be shown for failed tasks.
--show-errors-immediately	false	Show errors with tracebacks as soon as the task fails.
--show-locals	false	Show local variables in tracebacks.
--show-traceback / --show-no-traceback	--show-traceback	Choose whether tracebacks should be displayed or not.
--sort-table / --do-not-sort-table	--sort-table	Sort the table of tasks at the end of the execution.
--strict-markers	false	Raise errors for unknown markers.
--trace	false	Enter debugger in the beginning of each task.
-v, --verbose INTEGER RANGE	1	Make pytask verbose (>= 0) or quiet (= 0).
-x, --stop-after-first-failure	false	Stop after the first failure.
-h, --help	-	Show this message and exit.