Cargo Make

cargo-make, a Rust task runner and build tool

Type object
File match Makefile.toml
Schema URL https://catalog.lintel.tools/schemas/schemastore/cargo-make/latest.json
Source https://www.schemastore.org/cargo-make.json

Validate with Lintel

npx @lintel/lintel check
Type: object

A schema for cargo-make makefiles

Properties

extend string | extend | extend[]

Extend an external makefile by importing its tasks and properties to this file. Paths are relative to this makefile

Default: "path/to/Makefile.toml"
Examples: "path/to/Makefile.toml", {"path":"path/to/Makefile.toml","optional":true}, [{"path":"path/to/Makefile.toml","optional":true}]
config object

Configuration options for this makefile

21 nested properties
skip_core_tasks boolean

If true, the default core tasks will not be loaded

Default: false
skip_git_env_info boolean

If true, the Git related environment variables will not be loaded

Default: false
skip_rust_env_info boolean

If true, the rust related environment variables will not be loaded

Default: false
skip_crate_env_info boolean

If true, the current crate related environment variables will not be loaded

Default: false
modify_core_tasks object

Options to modify all the core tasks

Examples: {"private":true}, {"namespace":"default"}, {"private":true,"namespace":"default"}
2 nested properties
private boolean

If true, all core tasks will be set to private (default false)

Default: true
namespace string

If set to some value, all core tasks are modified to: namespace::name

Default: "default"
init_task string

Init task name which will be invoked at the start of every run

Default: "init"
end_task string

End task name which will be invoked at the end of every run

Default: "end"
on_error_task string

The name of the task to run in case of any error during the invocation of the flow

Default: "catch"
legacy_migration_task string

The name of the task which runs legacy migration flows

Default: "legacy-migration"
additional_profiles string[]

Additional profile names to load

Default:
[]
Examples: ["additional_profile"]
uniqueItems=true
min_version string
pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
default_to_workspace boolean

The default value for the workspace value of tasks in this makefile

Default: true
reduce_output boolean

Set to true to reduce console output for non CI execution

Default: true
time_summary boolean

Set to true to print time summary at the end of the flow

Default: true
load_cargo_aliases boolean

Automatically load cargo aliases as cargo-make tasks

Default: true
main_project_member string

The project information member (used by workspaces)

Default: "main-crate"
load_script string | string[] | object | object
linux_load_script string | string[] | object | object
windows_load_script string | string[] | object | object
mac_load_script string | string[] | object | object
unstable_features unstable_feature_flag[]

Specify unstable features to enable

Default:
[]
uniqueItems=true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env_scripts string[]

The environment scripts to execute after environment files and the env block. These scripts can be used to run anything needed before starting up the flow.

Default:
[]
tasks Record<string, object>

Task definitions

Definitions

semver string
extend object

A potentially optional external makefile to extend

path string required

The path of the external makefile, relative to this file

Default: "path/to/Makefile.toml"
optional boolean

If true, the external makefile is optional and does not need to exist

Default: true
relative const: "git" | const: "crate" | const: "workspace" | null

Where the path is relative to

Default: null
script string | string[] | object | object
env_files envfile[]

Load environment files

envfile string | object

File containing environment variables and their values

Examples:
  • "path/to/env.env"
  • { "path": "path/to/env.env", "profile": "development" }
env_value boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env

An environment variable value

env_value_unset object

Unsets environment variable

unset boolean required

If true, the env variable will be unset, else ignored

Default: true
env_value_script object

Provide environment variable via script

script string[] required
Default:
[]
multi_line boolean

Enable multi-line values

Default: true
env_value_decode object

Environment variable value provided by decoding other values

source string required

The source environment variable (can be an env expression)

mapping Record<string, string> required

The decoding mapping from one value to another value

Default:
{}
default_value string

The default value in case no decode mapping was found, if not provided it will default to the source value

env_value_conditioned object

Environment variable value set if condition is met

value string required

The value to set (can be an env expression)

condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

15 nested properties
fail_message string

Message to display when the condition fails

profiles string[]

Profile names to match for the condition

Default:
[]
platforms string[]

Platform names to match for the condition

channels string[]

Rust channels to match for the condition

env_set string[]

List of environment variables which must be defined

env_not_set string[]

List of environment variables which must not be defined

env_true string[]

List of environment variables which must be defined and must not be set to any of the following (case insensitive): false, no, 0, or empty

env_false string[]

List of environment variables which must be defined and must be set to any of the following (case insensitive): false, no, 0, or empty

env Record<string, string>

Map of environment variables that must be defined and equal to the provided values

env_contains Record<string, string>

Map of environment variables that must be defined and contain (case insensitive) the provided values

rust_version object

A definition of min, max and/or specific rust version

3 nested properties
min string
pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
max string
pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
equal string
pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
files_exist string[]

List of absolute path files to check they exist. Environment substitution is supported so you can define relative paths

files_not_exist string[]

List of absolute path files to check they do not exist. Environment substitution is supported so you can define relative paths

files_modified object

If any input file is newer than all output files, the condition is met. Environment substitution is supported so you can define relative paths

2 nested properties
input string[]

List of input globs

output string[]

List of output globs

condition_type string

How multiple conditions are evaluated

Default: "And"
Values: "And" "Or" "GroupOr"
env_value_path_glob object

Environment value holding a list of paths based on given glob definitions

glob string required

The glob used to fetch all paths

include_files boolean

If true, include files in glob

Default: true
include_dirs boolean

If true, include directories in glob

Default: true
ignore_type string

An ignore source that enables respecting ignore files from that source

Default: "git"
Values: "git"
task_condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

fail_message string

Message to display when the condition fails

profiles string[]

Profile names to match for the condition

Default:
[]
platforms string[]

Platform names to match for the condition

channels string[]

Rust channels to match for the condition

env_set string[]

List of environment variables which must be defined

env_not_set string[]

List of environment variables which must not be defined

env_true string[]

List of environment variables which must be defined and must not be set to any of the following (case insensitive): false, no, 0, or empty

env_false string[]

List of environment variables which must be defined and must be set to any of the following (case insensitive): false, no, 0, or empty

env Record<string, string>

Map of environment variables that must be defined and equal to the provided values

env_contains Record<string, string>

Map of environment variables that must be defined and contain (case insensitive) the provided values

rust_version object

A definition of min, max and/or specific rust version

3 nested properties
min string
pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
max string
pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
equal string
pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
files_exist string[]

List of absolute path files to check they exist. Environment substitution is supported so you can define relative paths

files_not_exist string[]

List of absolute path files to check they do not exist. Environment substitution is supported so you can define relative paths

files_modified object

If any input file is newer than all output files, the condition is met. Environment substitution is supported so you can define relative paths

2 nested properties
input string[]

List of input globs

output string[]

List of output globs

condition_type string

How multiple conditions are evaluated

Default: "And"
Values: "And" "Or" "GroupOr"
task object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

15 nested properties
fail_message string

Message to display when the condition fails

profiles string[]

Profile names to match for the condition

Default:
[]
platforms string[]

Platform names to match for the condition

channels string[]

Rust channels to match for the condition

env_set string[]

List of environment variables which must be defined

env_not_set string[]

List of environment variables which must not be defined

env_true string[]

List of environment variables which must be defined and must not be set to any of the following (case insensitive): false, no, 0, or empty

env_false string[]

List of environment variables which must be defined and must be set to any of the following (case insensitive): false, no, 0, or empty

env Record<string, string>

Map of environment variables that must be defined and equal to the provided values

env_contains Record<string, string>

Map of environment variables that must be defined and contain (case insensitive) the provided values

rust_version object

A definition of min, max and/or specific rust version

3 nested properties
min string
pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
max string
pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
equal string
pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
files_exist string[]

List of absolute path files to check they exist. Environment substitution is supported so you can define relative paths

files_not_exist string[]

List of absolute path files to check they do not exist. Environment substitution is supported so you can define relative paths

files_modified object

If any input file is newer than all output files, the condition is met. Environment substitution is supported so you can define relative paths

2 nested properties
input string[]

List of input globs

output string[]

List of output globs

condition_type string

How multiple conditions are evaluated

Default: "And"
Values: "And" "Or" "GroupOr"
condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

15 nested properties
fail_message string

Message to display when the condition fails

profiles string[]

Profile names to match for the condition

Default:
[]
platforms string[]

Platform names to match for the condition

channels string[]

Rust channels to match for the condition

env_set string[]

List of environment variables which must be defined

env_not_set string[]

List of environment variables which must not be defined

env_true string[]

List of environment variables which must be defined and must not be set to any of the following (case insensitive): false, no, 0, or empty

env_false string[]

List of environment variables which must be defined and must be set to any of the following (case insensitive): false, no, 0, or empty

env Record<string, string>

Map of environment variables that must be defined and equal to the provided values

env_contains Record<string, string>

Map of environment variables that must be defined and contain (case insensitive) the provided values

rust_version object

A definition of min, max and/or specific rust version

files_exist string[]

List of absolute path files to check they exist. Environment substitution is supported so you can define relative paths

files_not_exist string[]

List of absolute path files to check they do not exist. Environment substitution is supported so you can define relative paths

files_modified object

If any input file is newer than all output files, the condition is met. Environment substitution is supported so you can define relative paths

condition_type string

How multiple conditions are evaluated

Default: "And"
Values: "And" "Or" "GroupOr"
condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

15 nested properties
fail_message string

Message to display when the condition fails

profiles string[]

Profile names to match for the condition

Default:
[]
platforms string[]

Platform names to match for the condition

channels string[]

Rust channels to match for the condition

env_set string[]

List of environment variables which must be defined

env_not_set string[]

List of environment variables which must not be defined

env_true string[]

List of environment variables which must be defined and must not be set to any of the following (case insensitive): false, no, 0, or empty

env_false string[]

List of environment variables which must be defined and must be set to any of the following (case insensitive): false, no, 0, or empty

env Record<string, string>

Map of environment variables that must be defined and equal to the provided values

env_contains Record<string, string>

Map of environment variables that must be defined and contain (case insensitive) the provided values

rust_version object

A definition of min, max and/or specific rust version

files_exist string[]

List of absolute path files to check they exist. Environment substitution is supported so you can define relative paths

files_not_exist string[]

List of absolute path files to check they do not exist. Environment substitution is supported so you can define relative paths

files_modified object

If any input file is newer than all output files, the condition is met. Environment substitution is supported so you can define relative paths

condition_type string

How multiple conditions are evaluated

Default: "And"
Values: "And" "Or" "GroupOr"
condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

15 nested properties
fail_message string

Message to display when the condition fails

profiles string[]

Profile names to match for the condition

Default:
[]
platforms string[]

Platform names to match for the condition

channels string[]

Rust channels to match for the condition

env_set string[]

List of environment variables which must be defined

env_not_set string[]

List of environment variables which must not be defined

env_true string[]

List of environment variables which must be defined and must not be set to any of the following (case insensitive): false, no, 0, or empty

env_false string[]

List of environment variables which must be defined and must be set to any of the following (case insensitive): false, no, 0, or empty

env Record<string, string>

Map of environment variables that must be defined and equal to the provided values

env_contains Record<string, string>

Map of environment variables that must be defined and contain (case insensitive) the provided values

rust_version object

A definition of min, max and/or specific rust version

files_exist string[]

List of absolute path files to check they exist. Environment substitution is supported so you can define relative paths

files_not_exist string[]

List of absolute path files to check they do not exist. Environment substitution is supported so you can define relative paths

files_modified object

If any input file is newer than all output files, the condition is met. Environment substitution is supported so you can define relative paths

condition_type string

How multiple conditions are evaluated

Default: "And"
Values: "And" "Or" "GroupOr"
condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

36 nested properties
clear boolean

If true, it should ignore all data in the base task

Default: true
description string

A description used to document the task

category string

Category name used to document the task

disabled boolean

If true, the command/script of this task will not be invoked, but dependencies will be

Default: true
private boolean

If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

Default: true
deprecated boolean | string

If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

Default: true
extend string

Extends the specified task as a base task

workspace boolean

Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

Default: false
watch boolean | object

Watch for file changes and invoke the task operation

Default: true
condition object

Conditions allow you to evaluate at runtime if to run a specific task or not

condition_script string[]

If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

ignore_errors boolean

If true, any error while executing the task will be printed but will not break the build

Default: true
force boolean

DEPRECATED, replaced with ignore_errors

Default: true
env_files envfile[]

Load environment files

Default:
[]
uniqueItems=true
env Record<string, boolean | integer | string | string[] | env_value_unset | env_value_script | env_value_decode | env_value_conditioned | env_value_path_glob | env>

Setup environment variables

cwd string

The working directory for the task to execute its command/script

Default: "path/to/dir"
alias string

If defined, task points to another task and all other properties are ignored

linux_alias string

If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over alias on Linux)

windows_alias string

If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over alias on Windows)

mac_alias string

If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over alias on Mac)

install_crate boolean | string | object | object | object

Indicates the provided crate needs to be installed (if needed) before running the task

install_crate_args string[]

Additional cargo install args

install_script string | string[] | object | object
command string

The command to execute for this task

args string[]

The args for the executed command

script string | string[] | object | object
script_runner string

The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

Examples: "@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"
script_runner_args string

The script runner arguments before the script file path

Examples: "-f"
script_extension string

The file extension to use for the script

Examples: "py", "pl", "js", "php", "ps1"
x-taplo
run_task string | object | object[]

Run a task as a sub-task at the end of executing this task

dependencies string | object[]

A list of tasks to execute before this task

toolchain string

The rust toolchain used to invoke the command or install the needed crates/components

linux object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

windows object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

mac object

A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

unstable_feature_flags unstable_feature_flag[]

Specify unstable features to enable

unstable_feature_flag enum

Unstable feature flag