Skip to content

docs: add missing CLI/config equivalents in environment.md #2997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
no-hup wants to merge 4 commits into
base: main
Choose a base branch
from
+96 −2
Open

docs: add missing CLI/config equivalents in environment.md #2997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ea3e163
docs: add missing cli and config equivalents to environment.md
no-hup Aug 24, 2026
974f2e7
docs: complete cli/config cross-references in environment.md
no-hup Sep 2, 2026
d50965c
Merge branch 'main' into docs/env-links
no-hup Sep 2, 2026
7d8cf1f
docs: fix broken cross-reference anchors and complete the audit
no-hup Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions website/src/next/docs/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,10 +388,16 @@ The following flags are used to control the behavior of

Allow insecure connections when fetching remote Taskfiles.

- **Config equivalent**: [`remote.insecure`](./config.md#remote-insecure)
- **Environment variable**: [`TASK_REMOTE_INSECURE`](./environment.md#task-remote-insecure)

#### `--offline`

Work in offline mode, preventing remote Taskfile fetching.

- **Config equivalent**: [`remote.offline`](./config.md#remote-offline)
- **Environment variable**: [`TASK_REMOTE_OFFLINE`](./environment.md#task-remote-offline)

#### `--download`

Forces task to download remote Taskfiles and ignore any cached versions.
Expand All @@ -400,6 +406,9 @@ Forces task to download remote Taskfiles and ignore any cached versions.

Timeout duration for remote operations (e.g., '30s', '5m').

- **Config equivalent**: [`remote.timeout`](./config.md#remote-timeout)
- **Environment variable**: [`TASK_REMOTE_TIMEOUT`](./environment.md#task-remote-timeout)

#### `--clear-cache`

Wipe the cache of remote Taskfiles and checksums.
Expand All @@ -408,11 +417,17 @@ Wipe the cache of remote Taskfiles and checksums.

Cache expiry duration for remote Taskfiles (e.g., '1h', '24h').

- **Config equivalent**: [`remote.cache-expiry`](./config.md#remote-cache-expiry)
- **Environment variable**: [`TASK_REMOTE_CACHE_EXPIRY`](./environment.md#task-remote-cache-expiry)

#### `--remote-cache-dir`

Directory where remote Taskfiles are cached. Can be an absolute path (e.g.,
`/var/cache/task`) or relative to the Taskfile directory.

- **Config equivalent**: [`remote.cache-dir`](./config.md#remote-cache-dir)
- **Environment variable**: [`TASK_REMOTE_CACHE_DIR`](./environment.md#task-remote-cache-dir)

#### `--trusted-hosts`

List of (comma-separated) trusted hosts for remote Taskfiles. Hosts in this list
Expand All @@ -423,18 +438,30 @@ for confirmation when they are first downloaded or when their checksums change.
The host matching includes the port if specified in the URL. Use with caution
and only add hosts you fully trust.

- **Config equivalent**: [`remote.trusted-hosts`](./config.md#remote-trusted-hosts)
- **Environment variable**: [`TASK_REMOTE_TRUSTED_HOSTS`](./environment.md#task-remote-trusted-hosts)

#### `--cacert`

Path to a custom CA certificate file for TLS verification.

- **Config equivalent**: [`remote.cacert`](./config.md#remote-cacert)
- **Environment variable**: [`TASK_REMOTE_CACERT`](./environment.md#task-remote-cacert)

#### `--cert`

Path to a client certificate file for mTLS authentication.

- **Config equivalent**: [`remote.cert`](./config.md#remote-cert)
- **Environment variable**: [`TASK_REMOTE_CERT`](./environment.md#task-remote-cert)

#### `--cert-key`

Path to the client certificate private key file.

- **Config equivalent**: [`remote.cert-key`](./config.md#remote-cert-key)
- **Environment variable**: [`TASK_REMOTE_CERT_KEY`](./environment.md#task-remote-cert-key)

## Exit Codes

Task uses specific exit codes to indicate different types of errors:
Expand Down
8 changes: 8 additions & 0 deletions website/src/next/docs/reference/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ failfast: true
variable. Requires a TTY. Task automatically detects non-TTY environments (CI
pipelines, etc.) and skips prompts.
- **CLI equivalent**: [`--interactive`](./cli.md#interactive)
- **Environment variable**: [`TASK_INTERACTIVE`](./environment.md#task-interactive)

```yaml
interactive: true
Expand All @@ -176,6 +177,7 @@ interactive: true
- **Default**: `./.task`
- **Description**: Directory to store Task temporary files, such as checksums
and temporary metadata. Relative paths are relative to the root Taskfile.
- **CLI equivalent**: [`--temp-dir`](./cli.md#temp-dir-path)
- **Environment variable**: [`TASK_TEMP_DIR`](./environment.md#task-temp-dir)

```yaml
Expand Down Expand Up @@ -305,6 +307,8 @@ task --trusted-hosts example.com:8080 -t https://example.com:8080/Taskfile.yml
- **Type**: `string`
- **Default**: `""`
- **Description**: Path to a custom CA certificate file for TLS verification
- **CLI equivalent**: [`--cacert`](./cli.md#cacert)
- **Environment variable**: [`TASK_REMOTE_CACERT`](./environment.md#task-remote-cacert)

```yaml
remote:
Expand All @@ -316,6 +320,8 @@ remote:
- **Type**: `string`
- **Default**: `""`
- **Description**: Path to a client certificate file for mTLS authentication
- **CLI equivalent**: [`--cert`](./cli.md#cert)
- **Environment variable**: [`TASK_REMOTE_CERT`](./environment.md#task-remote-cert)

```yaml
remote:
Expand All @@ -327,6 +333,8 @@ remote:
- **Type**: `string`
- **Default**: `""`
- **Description**: Path to the client certificate private key file
- **CLI equivalent**: [`--cert-key`](./cli.md#cert-key)
- **Environment variable**: [`TASK_REMOTE_CERT_KEY`](./environment.md#task-remote-cert-key)

```yaml
remote:
Expand Down
63 changes: 61 additions & 2 deletions website/src/next/docs/reference/environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,40 +28,46 @@ files > defaults.
- **Type**: `boolean` (`true`, `false`, `1`, `0`)
- **Default**: `false`
- **Description**: Enable verbose output for all tasks
- **CLI equivalent**: [`-v, --verbose`](./cli.md#v-verbose)
- **Config equivalent**: [`verbose`](./config.md#verbose)

### `TASK_SILENT`

- **Type**: `boolean` (`true`, `false`, `1`, `0`)
- **Default**: `false`
- **Description**: Disables echoing of commands
- **CLI equivalent**: [`-s, --silent`](./cli.md#s-silent)
- **Config equivalent**: [`silent`](./config.md#silent)

### `TASK_COLOR`

- **Type**: `boolean` (`true`, `false`, `1`, `0`)
- **Default**: `true`
- **Description**: Enable colored output
- **CLI equivalent**: [`-c, --color`](./cli.md#c-color)
- **Config equivalent**: [`color`](./config.md#color)

### `TASK_DISABLE_FUZZY`

- **Type**: `boolean` (`true`, `false`, `1`, `0`)
- **Default**: `false`
- **Description**: Disable fuzzy matching for task names
- **CLI equivalent**: [`--disable-fuzzy`](./cli.md#disable-fuzzy)
- **Config equivalent**: [`disable-fuzzy`](./config.md#disable-fuzzy)

### `TASK_CONCURRENCY`

- **Type**: `integer`
- **Description**: Limit number of tasks to run concurrently
- **CLI equivalent**: [`-C, --concurrency`](./cli.md#c-concurrency-number)
- **Config equivalent**: [`concurrency`](./config.md#concurrency)

### `TASK_FAILFAST`

- **Type**: `boolean` (`true`, `false`, `1`, `0`)
- **Default**: `false`
- **Description**: When running tasks in parallel, stop all tasks if one fails
- **CLI equivalent**: [`-F, --failfast`](./cli.md#f-failfast)
- **Config equivalent**: [`failfast`](./config.md#failfast)

### `TASK_DRY`
Expand All @@ -70,24 +76,28 @@ files > defaults.
- **Default**: `false`
- **Description**: Compiles and prints tasks in the order that they would be
run, without executing them
- **CLI equivalent**: [`-n, --dry`](./cli.md#n-dry)

### `TASK_ASSUME_YES`

- **Type**: `boolean` (`true`, `false`, `1`, `0`)
- **Default**: `false`
- **Description**: Assume "yes" as answer to all prompts
- **CLI equivalent**: [`-y, --yes`](./cli.md#y-yes)

### `TASK_INTERACTIVE`

- **Type**: `boolean` (`true`, `false`, `1`, `0`)
- **Default**: `false`
- **Description**: Prompt for missing required variables
- **CLI equivalent**: [`--interactive`](./cli.md#interactive)
- **Config equivalent**: [`interactive`](./config.md#interactive)

### `TASK_OUTPUT`

- **Type**: `string` (`interleaved`, `group`, `prefixed`)
- **Description**: Sets the output style
- **CLI equivalent**: [`--output`](./cli.md#o-output-mode)
- **CLI equivalent**: [`-o, --output`](./cli.md#o-output-mode)

### `TASK_OUTPUT_GROUP_BEGIN`

Expand Down Expand Up @@ -121,6 +131,9 @@ checksums and temporary metadata. Can be relative like `tmp/task` or absolute
like `/tmp/.task` or `~/.task`. Relative paths are relative to the root
Taskfile, not the working directory. Defaults to: `./.task`.

- **CLI equivalent**: [`--temp-dir`](./cli.md#temp-dir-path)
- **Config equivalent**: [`temp-dir`](./config.md#temp-dir)

### `TASK_CORE_UTILS`

This env controls whether the Bash interpreter will use its own core utilities
Expand All @@ -129,9 +142,27 @@ implemented in Go, or the ones available in the system. Valid values are `true`
other operating systems. We might consider making this enabled by default on all
platforms in the future.

### `NO_COLOR`

Disable color output. Any non-empty value turns colors off.

This is only consulted when color hasn't been set explicitly. The full order of
precedence is `--color` > `TASK_COLOR` > the `color` config key > `NO_COLOR` >
`FORCE_COLOR`/`CI` > TTY auto-detection, so `NO_COLOR` wins over `FORCE_COLOR`
and `CI` but loses to anything you set deliberately.

- **CLI equivalent**: [`-c, --color`](./cli.md#c-color)
- **Config equivalent**: [`color`](./config.md#color)

### `FORCE_COLOR`

Force color output usage.
Force color output usage, even when the output isn't a terminal. Any non-empty
value enables it. Overridden by `NO_COLOR`.

### `CI`

Treated the same as `FORCE_COLOR` when it parses as a truthy boolean, so colors
stay on in CI logs that aren't attached to a TTY. Overridden by `NO_COLOR`.

## Remote Taskfile Variables

Expand All @@ -142,28 +173,47 @@ The following variables are used to control the behavior of

Allow insecure connections when fetching remote Taskfiles.

- **CLI equivalent**: [`--insecure`](./cli.md#insecure)
- **Config equivalent**: [`remote.insecure`](./config.md#remote-insecure)

### `TASK_REMOTE_OFFLINE`

Work in offline mode, preventing remote Taskfile fetching.

- **CLI equivalent**: [`--offline`](./cli.md#offline)
- **Config equivalent**: [`remote.offline`](./config.md#remote-offline)

### `TASK_REMOTE_TIMEOUT`

Timeout duration for remote operations (e.g., '30s', '5m').

- **CLI equivalent**: [`--timeout`](./cli.md#timeout)
- **Config equivalent**: [`remote.timeout`](./config.md#remote-timeout)

### `TASK_REMOTE_CACHE_EXPIRY`

Cache expiry duration for remote Taskfiles (e.g., '1h', '24h').

- **CLI equivalent**: [`--expiry`](./cli.md#expiry)
- **Config equivalent**: [`remote.cache-expiry`](./config.md#remote-cache-expiry)

### `TASK_REMOTE_CACHE_DIR`

Directory where remote Taskfiles are cached. Can be an absolute path (e.g.,
`/var/cache/task`) or relative to the Taskfile directory.

- **CLI equivalent**: [`--remote-cache-dir`](./cli.md#remote-cache-dir)
- **Config equivalent**: [`remote.cache-dir`](./config.md#remote-cache-dir)

### `TASK_REMOTE_TRUSTED_HOSTS`

List of (comma-separated) trusted hosts for remote Taskfiles. Hosts in this list
will not prompt for confirmation when downloading Taskfiles.

- **CLI equivalent**: [`--trusted-hosts`](./cli.md#trusted-hosts)
- **Config equivalent**:
[`remote.trusted-hosts`](./config.md#remote-trusted-hosts)

Hosts in the trusted hosts list will automatically be trusted without prompting
for confirmation when they are first downloaded or when their checksums change.
The host matching includes the port if specified in the URL. Use with caution
Expand All @@ -173,14 +223,23 @@ and only add hosts you fully trust.

Path to a custom CA certificate file for TLS verification.

- **CLI equivalent**: [`--cacert`](./cli.md#cacert)
- **Config equivalent**: [`remote.cacert`](./config.md#remote-cacert)

### `TASK_REMOTE_CERT`

Path to a client certificate file for mTLS authentication.

- **CLI equivalent**: [`--cert`](./cli.md#cert)
- **Config equivalent**: [`remote.cert`](./config.md#remote-cert)

### `TASK_REMOTE_CERT_KEY`

Path to the client certificate private key file.

- **CLI equivalent**: [`--cert-key`](./cli.md#cert-key)
- **Config equivalent**: [`remote.cert-key`](./config.md#remote-cert-key)

### Custom Colors

All color variables are [ANSI color codes][ansi]. You can specify multiple codes
Expand Down