aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/runtime/read-env.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/runtime/read-env.md')
-rw-r--r--docs/guides/runtime/read-env.md32
1 files changed, 32 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.