aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-07-31 14:24:08 -0700
committerGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-07-31 14:24:08 -0700
commit7b8df184b3ac7df715d7e57aa6514f47f100bb59 (patch)
treeaa7237bc85475b8f35f627174172543c2227190e /docs
parent90991da908b0725802db63d9fd8d5b4de1eb21a5 (diff)
downloadbun-7b8df184b3ac7df715d7e57aa6514f47f100bb59.tar.gz
bun-7b8df184b3ac7df715d7e57aa6514f47f100bb59.tar.zst
bun-7b8df184b3ac7df715d7e57aa6514f47f100bb59.zip
Add env guides
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/runtime/read-env.md32
-rw-r--r--docs/guides/runtime/set-env.md37
2 files changed, 69 insertions, 0 deletions
diff --git a/docs/guides/runtime/read-env.md b/docs/guides/runtime/read-env.md
new file mode 100644
index 000000000..512f731dd
--- /dev/null
+++ b/docs/guides/runtime/read-env.md
@@ -0,0 +1,32 @@
+---
+name: Read environment variables
+---
+
+The current environment variables can be accessed via `process.env`.
+
+```ts
+process.env.API_TOKEN; // => "secret"
+```
+
+---
+
+Bun also exposes these variables via `Bun.env`, which is a simple alias of `process.env`.
+
+```ts
+Bun.env.API_TOKEN; // => "secret"
+```
+
+---
+
+To print all currently-set environment variables to the command line, run `bun run env`. This is useful for debugging.
+
+```sh
+$ bun run env
+BAZ=stuff
+FOOBAR=aaaaaa
+<lots more lines>
+```
+
+---
+
+See [Docs > Runtime > Environment variables](/docs/cli/run#environment-variables) for more information on using environment variables with Bun.
diff --git a/docs/guides/runtime/set-env.md b/docs/guides/runtime/set-env.md
new file mode 100644
index 000000000..97cac3488
--- /dev/null
+++ b/docs/guides/runtime/set-env.md
@@ -0,0 +1,37 @@
+---
+name: Set environment variables
+---
+
+The current environment variables can be accessed via `process.env` or `Bun.env`.
+
+```ts
+Bun.env.API_TOKEN; // => "secret"
+process.env.API_TOKEN; // => "secret"
+```
+
+---
+
+Set these variables in a `.env` file.
+
+Bun reads the following files automatically (listed in order of increasing precedence).
+
+- `.env`
+- `.env.production` or `.env.development` (depending on value of `NODE_ENV`)
+- `.env.local`
+
+```txt#.env
+FOO=hello
+BAR=world
+```
+
+---
+
+Variables can also be set via the command line.
+
+```sh
+$ FOO=helloworld bun run dev
+```
+
+---
+
+See [Docs > Runtime > Environment variables](/docs/cli/run#environment-variables) for more information on using environment variables with Bun.