task/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/api_reference.md

slug	sidebar_position	toc_min_heading_level	toc_max_heading_level
/api/	4	2	5

Referência da API

CLI

O comando "task" tem a seguinte sintaxe:

task [--flags] [tasks...] [-- CLI_ARGS...]

:::tip

Se -- é informado, todos os argumentos remanescentes serão atribuídos a uma variável especial chamada CLI_ARGS

:::

Abreviação	Modificador	Tipo	Predefinição	Descrição
-c	--color	bool	true	Saída colorida. Habilitado por padrão. Defina o modificador como false ou use NO_COLOR=1 para desativar.
-C	--concurrency	int	0	Limitar número de tarefas a serem executadas simultaneamente. Zero significa ilimitado.
-d	--dir	string	Pasta atual	Define a pasta de execução.
-n	--dry	bool	false	Compila e imprime as tarefas na ordem em que elas seriam executadas, sem executá-las.
-x	--exit-code	bool	false	Faz com que o código de saída do comando sendo executado seja repassado pelo Task.
-f	--force	bool	false	Força a execução mesmo quando a tarefa está atualizada.
-g	--global	bool	false	Executa o Taskfile global, de $HOME/Taskfile.{yml,yaml}.
-h	--help	bool	false	Mostra a ajuda do Task.
-i	--init	bool	false	Cria um novo Taskfile.yml na pasta atual.
-I	--interval	string	5s	Define um intervalo de tempo diferente ao usar --watch, o padrão sendo 5 segundos. Este valor deve ser um Go Duration válido.
-l	--list	bool	false	Lista as tarefas com descrição do Taskfile atual.
-a	--list-all	bool	false	Lista todas as tarefas, com ou sem descrição.
	--sort	string	default	Altera a ordem das tarefas quando listadas.
	--json	bool	false	Imprime a saída em JSON.
-o	--output	string	O padrão é o que está definido no Taskfile, ou então intervealed.	Configura o estilo de saída: [interleaved/group/prefixed].
	--output-group-begin	string		Formato de mensagem a imprimir antes da saída agrupada de uma tarefa.
	--output-group-end	string		Formato de mensagem a imprimir depois da saída agrupada de uma tarefa.
	--output-group-error-only	bool	false	Oculta saída dos comandos que terminarem sem erro.
-p	--parallel	bool	false	Executa as tarefas fornecidas na linha de comando em paralelo.
-s	--silent	bool	false	Desabilita impressão.
-y	--yes	bool	false	Assume "yes" as answer to all prompts.
	--status	bool	false	Sai com código de saída diferente de zero se alguma das tarefas especificadas não estiver atualizada.
	--summary	bool	false	Mostrar resumo sobre uma tarefa.
-t	--taskfile	string	Taskfile.yml ou Taskfile.yaml
-v	--verbose	bool	false	Habilita modo verboso.
	--version	bool	false	Mostrar versão do Task.
-w	--watch	bool	false	Habilita o monitoramento de tarefas.

Códigos de saída

O Task às vezes fecha com códigos de saída específicos. These codes are split into three groups with the following ranges:

• Erros gerais (0-99)
• Erros de Taskfile (100-199)
• Erros de execução de tarefa (200-299)

Uma lista completa dos códigos de saída e suas descrições podem ser encontradas abaixo:

Código	Descrição
0	Sucesso
1	Um erro desconhecido ocorreu
100	Nenhum Arquivo foi encontrado
101	Um arquivo Taskfile já existe ao tentar inicializar um
102	O arquivo Taskfile é inválido ou não pode ser analisado
200	A tarefa especificada não pôde ser encontrada
201	Ocorreu um erro ao executar um comando dentro de uma tarefa
202	O usuário tentou invocar uma tarefa que é interna
203	Há várias tarefas com o mesmo nome ou apelido
204	Uma tarefa foi chamada muitas vezes
205	A task was cancelled by the user

These codes can also be found in the repository in errors/errors.go.

:::info

When Task is run with the -x/--exit-code flag, the exit code of any failed commands will be passed through to the user instead.

:::

Saída em JSON

Quando estiver usando o modificador --json em combinação com o modificador --list ou --list-all, a saída será um objeto JSON com a seguinte estrutura:

{
  "tasks": [
    {
      "name": "",
      "desc": "",
      "summary": "",
      "up_to_date": false,
      "location": {
        "line": 54,
        "column": 3,
        "taskfile": "/path/to/Taskfile.yml"
      }
    }
    // ...
  ],
  "location": "/path/to/Taskfile.yml"
}

Variáveis Especiais

There are some special variables that is available on the templating system:

Var	Description
CLI_ARGS	Contain all extra arguments passed after -- when calling Task through the CLI.
TASK	The name of the current task.
ROOT_DIR	The absolute path of the root Taskfile.
TASKFILE_DIR	The absolute path of the included Taskfile.
USER_WORKING_DIR	The absolute path of the directory task was called from.
CHECKSUM	The checksum of the files listed in sources. Only available within the status prop and if method is set to checksum.
TIMESTAMP	The date object of the greatest timestamp of the files listes in sources. Only available within the status prop and if method is set to timestamp.
TASK_VERSION	The current version of task.

ENV

Some environment variables can be overriden to adjust Task behavior.

ENV	Default	Description
TASK_TEMP_DIR	.task	Location of the temp dir. Can relative to the project like tmp/task or absolute like /tmp/.task or ~/.task.
TASK_COLOR_RESET	0	Color used for white.
TASK_COLOR_BLUE	34	Color used for blue.
TASK_COLOR_GREEN	32	Color used for green.
TASK_COLOR_CYAN	36	Color used for cyan.
TASK_COLOR_YELLOW	33	Color used for yellow.
TASK_COLOR_MAGENTA	35	Color used for magenta.
TASK_COLOR_RED	31	Color used for red.
FORCE_COLOR		Force color output usage.

Taskfile Schema

Attribute	Type	Default	Description
version	string		Version of the Taskfile. The current version is 3.
output	string	interleaved	Output mode. Available options: interleaved, group and prefixed.
method	string	checksum	Default method in this Taskfile. Can be overriden in a task by task basis. Available options: checksum, timestamp and none.
includes	map[string]Include		Additional Taskfiles to be included.
vars	map[string]Variable		A set of global variables.
env	map[string]Variable		A set of global environment variables.
tasks	map[string]Task		A set of task definitions.
silent	bool	false	Default 'silent' options for this Taskfile. If false, can be overidden with true in a task by task basis.
dotenv	[]string		A list of .env file paths to be parsed.
run	string	always	Default 'run' option for this Taskfile. Available options: always, once and when_changed.
interval	string	5s	Sets a different watch interval when using --watch, the default being 5 seconds. This string should be a valid Go Duration.
set	[]string		Specify options for the set builtin.
shopt	[]string		Specify option for the shopt builtin.

Include

Attribute	Type	Default	Description
taskfile	string		The path for the Taskfile or directory to be included. If a directory, Task will look for files named Taskfile.yml or Taskfile.yaml inside that directory. If a relative path, resolved relative to the directory containing the including Taskfile.
dir	string	The parent Taskfile directory	The working directory of the included tasks when run.
optional	bool	false	If true, no errors will be thrown if the specified file does not exist.
internal	bool	false	Stops any task in the included Taskfile from being callable on the command line. These commands will also be omitted from the output when used with --list.
aliases	[]string		Alternative names for the namespace of the included Taskfile.
vars	map[string]Variable		A set of variables to apply to the included Taskfile.

:::info

Informing only a string like below is equivalent to setting that value to the taskfile attribute.

includes:
  foo: ./path

:::

Variable

Attribute	Type	Default	Description
itself	string		A static value that will be set to the variable.
sh	string		A shell command. The output (STDOUT) will be assigned to the variable.

:::info

Static and dynamic variables have different syntaxes, like below:

vars:
  STATIC: static
  DYNAMIC:
    sh: echo "dynamic"

:::

Task

Attribute	Type	Default	Description
cmds	[]Command		A list of shell commands to be executed.
deps	[]Dependency		A list of dependencies of this task. Tasks defined here will run in parallel before this task.
label	string		Overrides the name of the task in the output when a task is run. Supports variables.
desc	string		A short description of the task. This is displayed when calling task --list.
prompt	string		A prompt that will be presented before a task is run. Declining will cancel running the current and any subsequent tasks.
summary	string		A longer description of the task. This is displayed when calling task --summary [task].
aliases	[]string		A list of alternative names by which the task can be called.
sources	[]string		A list of sources to check before running this task. Relevant for checksum and timestamp methods. Can be file paths or star globs.
generates	[]string		A list of files meant to be generated by this task. Relevant for timestamp method. Can be file paths or star globs.
status	[]string		A list of commands to check if this task should run. The task is skipped otherwise. This overrides method, sources and generates.
preconditions	[]Precondition		A list of commands to check if this task should run. If a condition is not met, the task will error.
dir	string		The directory in which this task should run. Defaults to the current working directory.
vars	map[string]Variable		A set of variables that can be used in the task.
env	map[string]Variable		A set of environment variables that will be made available to shell commands.
dotenv	[]string		A list of .env file paths to be parsed.
silent	bool	false	Hides task name and command from output. The command's output will still be redirected to STDOUT and STDERR. When combined with the --list flag, task descriptions will be hidden.
interactive	bool	false	Tells task that the command is interactive.
internal	bool	false	Stops a task from being callable on the command line. It will also be omitted from the output when used with --list.
method	string	checksum	Defines which method is used to check the task is up-to-date. timestamp will compare the timestamp of the sources and generates files. checksum will check the checksum (You probably want to ignore the .task folder in your .gitignore file). none skips any validation and always run the task.
prefix	string		Defines a string to prefix the output of tasks running in parallel. Only used when the output mode is prefixed.
ignore_error	bool	false	Continue execution if errors happen while executing commands.
run	string	The one declared globally in the Taskfile or always	Specifies whether the task should run again or not if called more than once. Available options: always, once and when_changed.
platforms	[]string	All platforms	Specifies which platforms the task should be run on. Valid GOOS and GOARCH values allowed. Task will be skipped otherwise.
set	[]string		Specify options for the set builtin.
shopt	[]string		Specify option for the shopt builtin.

:::info

These alternative syntaxes are available. They will set the given values to cmds and everything else will be set to their default values:

tasks:
  foo: echo "foo"

  foobar:
    - echo "foo"
    - echo "bar"

  baz:
    cmd: echo "baz"

:::

Command

Attribute	Type	Default	Description
cmd	string		The shell command to be executed.
silent	bool	false	Skips some output for this command. Note that STDOUT and STDERR of the commands will still be redirected.
task	string		Set this to trigger execution of another task instead of running a command. This cannot be set together with cmd.
vars	map[string]Variable		Optional additional variables to be passed to the referenced task. Only relevant when setting task instead of cmd.
ignore_error	bool	false	Continue execution if errors happen while executing the command.
defer	string		Alternative to cmd, but schedules the command to be executed at the end of this task instead of immediately. This cannot be used together with cmd.
platforms	[]string	All platforms	Specifies which platforms the command should be run on. Valid GOOS and GOARCH values allowed. Command will be skipped otherwise.
set	[]string		Specify options for the set builtin.
shopt	[]string		Specify option for the shopt builtin.

:::info

If given as a a string, the value will be assigned to cmd:

tasks:
  foo:
    cmds:
      - echo "foo"
      - echo "bar"

:::

Dependency

Attribute	Type	Default	Description
task	string		The task to be execute as a dependency.
vars	map[string]Variable		Optional additional variables to be passed to this task.
silent	bool	false	Hides task name and command from output. The command's output will still be redirected to STDOUT and STDERR.

:::tip

If you don't want to set additional variables, it's enough to declare the dependency as a list of strings (they will be assigned to task):

tasks:
  foo:
    deps: [foo, bar]

:::

Precondition

Attribute	Type	Default	Description
sh	string		Command to be executed. If a non-zero exit code is returned, the task errors without executing its commands.
msg	string		Optional message to print if the precondition isn't met.

:::tip

If you don't want to set a different message, you can declare a precondition like this and the value will be assigned to sh:

tasks:
  foo:
    precondition: test -f Taskfile.yml

:::