latest--partial-poe
shared| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/pyproject/_shared/latest--partial-poe.json |
| Parent schema | pyproject |
Poe the Poet is a task runner and build tool that uses simple configuration to define project tasks. It can work as a standalone tool or as a plugin for Poetry.
Properties
When a task is declared as a string inside an array (e.g. inline in a sequence task), then it is interpreted as the default array item task type, which will be 'ref' unless otherwise specified.
When a task is declared as an array (instead of a table), then it is interpreted as the default array task type, which will be 'sequence' unless otherwise specified.
Sets the default task type for tasks defined as strings. By default, tasks are interpreted as shell commands ('cmd'). This can be overridden to 'script' or other supported types.
Provide one or more env files to be loaded before running this task. If an array is provided, files will be loaded in the given order.
Configure the executor type for running tasks. Can be 'auto', 'poetry', 'virtualenv', or 'simple', with 'auto' being the default.
Specify one or more other toml or json files to load tasks from.
Load dynamically generated tasks from one or more python functions.
Change the name of the task poe registers with poetry when used as a plugin.
Register tasks to run automatically before or after other poetry CLI commands.
Change the default shell interpreter for executing shell tasks. Normally, tasks are executed using a posix shell, but this can be overridden here.
Sets the default verbosity level for all commands. '-1' is quieter, '0' is the default level, and '1' is more verbose. The command line arguments are incremental, with '--quiet' or '-q' decreasing verbosity, and '--verbose' or '-v' increasing it.
Definitions
Define CLI options, positional arguments, or flags that this task should accept.
Specify the current working directory that this task should run with. This can be a relative path from the project root or an absolute path, and environment variables can be used in the format ${VAR_NAME}.
A list of task invocations that will be executed before this one. Each item in the list is a reference to another task defined within the tasks object.
Provide one or more env files to be loaded before running this task. If an array is provided, files will be loaded in the given order.
Help text to be displayed next to the task name in the documentation when poe is run without specifying a task.
Allows this task to use the output of other tasks which are executed first. The values are references to the names of the tasks, and the keys are environment variables by which the results of those tasks will be accessible in this task.
Configure the executor type for running tasks. Can be 'auto', 'poetry', 'virtualenv', or 'simple', with 'auto' being the default.
Specify the verbosity level for this task, from -2 (least verbose) to 2 (most verbose), overriding the project level verbosity setting, which defaults to 0.
Redirects the task output to a file with the given path. Supports environment variable interpolation.
Specify that this task should be executed in the same process, instead of as a subprocess. Note: This feature has limitations, such as not being compatible with tasks that are referenced by other tasks and not working on Windows.
Return exit code 0 even if the task fails, or specify a list of task exit codes to ignore.
true
If set, the sequence will continue running even if one of the tasks fails.
true"return_zero""return_non_zero"
Provide one or more env files to be loaded before running this task. If an array is provided, files will be loaded in the given order.
Configure the executor type for running tasks. Can be 'auto', 'poetry', 'virtualenv', or 'simple', with 'auto' being the default.