diff options
| author |  Ashcon Partovi <ashcon@partovi.net>
| 2023-06-02 14:24:16 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-06-02 14:24:16 -0700 |
| commit | bfd315fc72749ecd98150de110f2a9cc586c7293 (patch) | |
| tree | f31eb78df5d01a683c3022ce04a122d1dbf6e81e /docs/runtime | |
| parent | 72c2123e07c936d1c279c5f4effb096f24bc1f58 (diff) | |
| download | bun-bfd315fc72749ecd98150de110f2a9cc586c7293.tar.gz bun-bfd315fc72749ecd98150de110f2a9cc586c7293.tar.zst bun-bfd315fc72749ecd98150de110f2a9cc586c7293.zip | |
Support `NO_COLOR` environment variable (#3055)
Diffstat (limited to 'docs/runtime')
| -rw-r--r-- | docs/runtime/configuration.md | 30 |
1 files changed, 27 insertions, 3 deletions
diff --git a/docs/runtime/configuration.md b/docs/runtime/configuration.md index 83a6ae37f..8dc2bfe24 100644 --- a/docs/runtime/configuration.md +++ b/docs/runtime/configuration.md @@ -14,10 +14,34 @@ If both a global and local `bunfig` are detected, the results are shallow-merged ## Environment variables -<!-- - `GOMAXPROCS`: For `bun bun`, this sets the maximum number of threads to use. If you’re experiencing an issue with `bun bun`, try setting `GOMAXPROCS=1` to force Bun to run single-threaded --> +These environment variables are checked by Bun to detect functionality and toggle features. -- `DISABLE_BUN_ANALYTICS=1` this disables Bun's analytics. Bun records bundle timings (so we can answer with data, "is Bun getting faster?") and feature usage (e.g., "are people actually using macros?"). The request body size is about 60 bytes, so it’s not a lot of data -- `TMPDIR`: Bun occasionally requires a directory to store intermediate assets during bundling or other operations. If unset, `TMPDIR` defaults to the platform-specific temporary directory (on Linux, `/tmp` and on macOS `/private/tmp`). +{% table %} + +- Name +- Description + +--- + +- `TMPDIR` +- Bun occasionally requires a directory to store intermediate assets during bundling or other operations. If unset, defaults to the platform-specific temporary directory: `/tmp` on Linux, `/private/tmp` on macOS. + +--- + +- `NO_COLOR` +- If `NO_COLOR=1`, then ANSI color output is [disabled](https://no-color.org/). + +--- + +- `FORCE_COLOR` +- If `FORCE_COLOR=1`, then ANSI color output is force enabled, even if `NO_COLOR` is set. + +--- + +- `DO_NOT_TRACK` +- If `DO_NOT_TRACK=1`, then analytics are [disabled](https://do-not-track.dev/). Bun records bundle timings (so we can answer with data, "is Bun getting faster?") and feature usage (e.g., "are people actually using macros?"). The request body size is about 60 bytes, so it's not a lot of data. + +{% /table %} ## Runtime |