From ea3e163fe8b211a3c440c64e7da7a6a1f879e229 Mon Sep 17 00:00:00 2001 From: Shaurya <19599684+no-hup@users.noreply.github.com> Date: Mon, 24 Aug 2026 17:22:08 +0530 Subject: [PATCH 1/3] docs: add missing cli and config equivalents to environment.md --- website/src/next/docs/reference/environment.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/website/src/next/docs/reference/environment.md b/website/src/next/docs/reference/environment.md index 87bc29c7fc..b35d9b4bae 100644 --- a/website/src/next/docs/reference/environment.md +++ b/website/src/next/docs/reference/environment.md @@ -55,6 +55,7 @@ files > defaults. - **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` @@ -62,6 +63,7 @@ files > defaults. - **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` @@ -70,18 +72,22 @@ 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` From 974f2e7723f0e4e490cfaef423fc2fd0ab6f0819 Mon Sep 17 00:00:00 2001 From: no-hup <19599684+no-hup@users.noreply.github.com> Date: Wed, 2 Sep 2026 07:59:10 +0530 Subject: [PATCH 2/3] docs: complete cli/config cross-references in environment.md Audit every TASK_ variable against internal/flags/flags.go and add the missing CLI and config equivalents. Also fix the TASK_OUTPUT link, which pointed at a non-existent #--output-string anchor. --- .../src/next/docs/reference/environment.md | 37 ++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/website/src/next/docs/reference/environment.md b/website/src/next/docs/reference/environment.md index b35d9b4bae..2b4bf3783d 100644 --- a/website/src/next/docs/reference/environment.md +++ b/website/src/next/docs/reference/environment.md @@ -28,6 +28,7 @@ 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` @@ -35,6 +36,7 @@ files > defaults. - **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` @@ -42,6 +44,7 @@ files > defaults. - **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` @@ -49,6 +52,7 @@ files > defaults. - **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` @@ -93,7 +97,7 @@ files > defaults. - **Type**: `string` (`interleaved`, `group`, `prefixed`) - **Description**: Sets the output style -- **CLI equivalent**: [`--output`](./cli.md#--output-string) +- **CLI equivalent**: [`-o, --output`](./cli.md#-o---output-mode) ### `TASK_OUTPUT_GROUP_BEGIN` @@ -127,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 @@ -148,28 +155,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 @@ -179,14 +205,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 From 7d8cf1fc0ac8bd37b50d73df6abf7e0d158a9525 Mon Sep 17 00:00:00 2001 From: Shaurya <19599684+no-hup@users.noreply.github.com> Date: Wed, 2 Sep 2026 09:22:13 +0530 Subject: [PATCH 3/3] docs: fix broken cross-reference anchors and complete the audit The anchors added in this branch used the `#--flag-name` style that already existed in these pages, but VitePress strips leading hyphens when it slugifies a heading, so every one of them was dead. #3004 had just fixed four of the pre-existing ones the same way. - environment.md: repair 19 anchors, document NO_COLOR and CI (both are read in internal/flags/flags.go and NO_COLOR takes precedence over the already-documented FORCE_COLOR) - cli.md: the Remote section had no cross-references at all; 9 of its 11 flags have both a config key and an env var, so link them - config.md: interactive was missing its env var, temp-dir its CLI flag, and remote.cacert/cert/cert-key had neither --- website/src/next/docs/reference/cli.md | 27 +++++++++++++++++++++++ website/src/next/docs/reference/config.md | 8 +++++++ 2 files changed, 35 insertions(+) diff --git a/website/src/next/docs/reference/cli.md b/website/src/next/docs/reference/cli.md index 0051797355..c5d0845524 100644 --- a/website/src/next/docs/reference/cli.md +++ b/website/src/next/docs/reference/cli.md @@ -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. @@ -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. @@ -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 @@ -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: diff --git a/website/src/next/docs/reference/config.md b/website/src/next/docs/reference/config.md index be606b876b..bc6730f231 100644 --- a/website/src/next/docs/reference/config.md +++ b/website/src/next/docs/reference/config.md @@ -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 @@ -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 @@ -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: @@ -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: @@ -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: