jarle/Bun Environment Variables

Environment Variables

Read and configure environment variables in Bun, including automatic .env file support

Bun reads your .env files automatically and provides idiomatic ways to read and write your environment variables programmatically. Plus, some aspects of Bun's runtime behavior can be configured with Bun-specific environment variables.

Setting environment variables

Bun reads the following files automatically (listed in order of increasing precedence).

• .env
• .env.production, .env.development, .env.test (depending on value of NODE_ENV)
• .env.local

FOO=hello
BAR=world

Variables can also be set via the command line.

<CodeGroup> ```sh Linux/macOS icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}} FOO=helloworld bun run dev ```

# Using CMD
set FOO=helloworld && bun run dev

# Using PowerShell
$env:FOO="helloworld"; bun run dev

</CodeGroup> <Accordion title="Cross-platform solution with Windows"> For a cross-platform solution, you can use [bun shell](/runtime/shell). For example, the `bun exec` command.

bun exec 'FOO=helloworld bun run dev'

On Windows, package.json scripts called with bun run will automatically use the bun shell, making the following also cross-platform.

"scripts": {
  "dev": "NODE_ENV=development bun --watch app.ts",
},

</Accordion>

Or programmatically by assigning a property to process.env.

process.env.FOO = "hello";

---

Manually specifying .env files

Bun supports --env-file to override which specific .env file to load. You can use --env-file when running scripts in bun's runtime, or when running package.json scripts.

bun --env-file=.env.1 src/index.ts

bun --env-file=.env.abc --env-file=.env.def run build

Disabling automatic .env loading

Use --no-env-file to disable Bun's automatic .env file loading. This is useful in production environments or CI/CD pipelines where you want to rely solely on system environment variables.

bun run --no-env-file index.ts

This can also be configured in bunfig.toml:

# Disable loading .env files
env = false

Explicitly provided environment files via --env-file will still be loaded even when default loading is disabled.

---

Quotation marks

Bun supports double quotes, single quotes, and template literal backticks:

FOO='hello'
FOO="hello"
FOO=`hello`

Expansion

Environment variables are automatically expanded. This means you can reference previously-defined variables in your environment variables.

FOO=world
BAR=hello$FOO

process.env.BAR; // => "helloworld"

This is useful for constructing connection strings or other compound values.

DB_USER=postgres
DB_PASSWORD=secret
DB_HOST=localhost
DB_PORT=5432
DB_URL=postgres://$DB_USER:$DB_PASSWORD@$DB_HOST:$DB_PORT/$DB_NAME

This can be disabled by escaping the $ with a backslash.

FOO=world
BAR=hello\$FOO

process.env.BAR; // => "hello$FOO"

dotenv

Generally speaking, you won't need dotenv or dotenv-expand anymore, because Bun reads .env files automatically.

Reading environment variables

The current environment variables can be accessed via process.env.

process.env.API_TOKEN; // => "secret"

Bun also exposes these variables via Bun.env and import.meta.env, which is a simple alias of process.env.

Bun.env.API_TOKEN; // => "secret"
import.meta.env.API_TOKEN; // => "secret"

To print all currently-set environment variables to the command line, run bun --print process.env. This is useful for debugging.

bun --print process.env
BAZ=stuff
FOOBAR=aaaaaa
<lots more lines>

TypeScript

In TypeScript, all properties of process.env are typed as string | undefined.

Bun.env.whatever;
// string | undefined

To get autocompletion and tell TypeScript to treat a variable as a non-optional string, we'll use interface merging.

declare module "bun" {
  interface Env {
    AWESOME: string;
  }
}

Add this line to any file in your project. It will globally add the AWESOME property to process.env and Bun.env.

process.env.AWESOME; // => string

Configuring Bun

These environment variables are read by Bun and configure aspects of its behavior.

| Name | Description | | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | NODE_TLS_REJECT_UNAUTHORIZED | NODE_TLS_REJECT_UNAUTHORIZED=0 disables SSL certificate validation. This is useful for testing and debugging, but you should be very hesitant to use this in production. Note: This environment variable was originally introduced by Node.js and we kept the name for compatibility. | | BUN_CONFIG_VERBOSE_FETCH | If BUN_CONFIG_VERBOSE_FETCH=curl, then fetch requests will log the url, method, request headers and response headers to the console. This is useful for debugging network requests. This also works with node:http. BUN_CONFIG_VERBOSE_FETCH=1 is equivalent to BUN_CONFIG_VERBOSE_FETCH=curl except without the curl output. | | BUN_RUNTIME_TRANSPILER_CACHE_PATH | The runtime transpiler caches the transpiled output of source files larger than 50 kb. This makes CLIs using Bun load faster. If BUN_RUNTIME_TRANSPILER_CACHE_PATH is set, then the runtime transpiler will cache transpiled output to the specified directory. If BUN_RUNTIME_TRANSPILER_CACHE_PATH is set to an empty string or the string "0", then the runtime transpiler will not cache transpiled output. If BUN_RUNTIME_TRANSPILER_CACHE_PATH is unset, then the runtime transpiler will cache transpiled output to the platform-specific cache directory. | | 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. | | FORCE_COLOR | If FORCE_COLOR=1, then ANSI color output is force enabled, even if NO_COLOR is set. | | BUN_CONFIG_MAX_HTTP_REQUESTS | Control the maximum number of concurrent HTTP requests sent by fetch and bun install. Defaults to 256. If you are running into rate limits or connection issues, you can reduce this number. | | BUN_CONFIG_NO_CLEAR_TERMINAL_ON_RELOAD | If BUN_CONFIG_NO_CLEAR_TERMINAL_ON_RELOAD=true, then bun --watch will not clear the console on reload | | DO_NOT_TRACK | Disable uploading crash reports to bun.report on crash. On macOS & Windows, crash report uploads are enabled by default. Otherwise, telemetry is not sent yet as of May 21st, 2024, but we are planning to add telemetry in the coming weeks. If DO_NOT_TRACK=1, then auto-uploading crash reports and telemetry are both disabled. | | BUN_OPTIONS | Prepends command-line arguments to any Bun execution. For example, BUN_OPTIONS="--hot" makes bun run dev behave like bun --hot run dev |

Runtime transpiler caching

For files larger than 50 KB, Bun caches transpiled output into $BUN_RUNTIME_TRANSPILER_CACHE_PATH or the platform-specific cache directory. This makes CLIs using Bun load faster.

This transpiler cache is global and shared across all projects. It is safe to delete the cache at any time. It is a content-addressable cache, so it will never contain duplicate entries. It is also safe to delete the cache while a Bun process is running.

It is recommended to disable this cache when using ephemeral filesystems like Docker. Bun's Docker images automatically disable this cache.

Disable the runtime transpiler cache

To disable the runtime transpiler cache, set BUN_RUNTIME_TRANSPILER_CACHE_PATH to an empty string or the string "0".

BUN_RUNTIME_TRANSPILER_CACHE_PATH=0 bun run dev

What does it cache?

It caches:

• The transpiled output of source files larger than 50 KB.
• The sourcemap for the transpiled output of the file

The file extension .pile is used for these cached files.