diff options
| author |  Colin McDonnell <colinmcd94@gmail.com>
| 2023-04-13 18:26:45 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-04-13 18:26:45 -0700 |
| commit | 011e157cac7698050370e24495a9002dacfceea9 (patch) | |
| tree | ebb561dbda3e8f67302cc4d5b398f4a2744f7884 /docs/cli/bunx.md | |
| parent | 0cc56e8efce9c7d4905b3649827bf9b40a677b25 (diff) | |
| download | bun-011e157cac7698050370e24495a9002dacfceea9.tar.gz bun-011e157cac7698050370e24495a9002dacfceea9.tar.zst bun-011e157cac7698050370e24495a9002dacfceea9.zip | |
Docs restructuring (#2638)
* Restructure
* Update nav
* Reorg
* Reshuffle ecosystem pages
* Split up runtime/runtime
* Back to runtime/index
* Fix issue
* Split up runtime/index
* Add Writing Tests page
* Prettier matcher table
* More updates
Diffstat (limited to 'docs/cli/bunx.md')
| -rw-r--r-- | docs/cli/bunx.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/cli/bunx.md b/docs/cli/bunx.md index 0e6787fc1..fe7bd80a2 100644 --- a/docs/cli/bunx.md +++ b/docs/cli/bunx.md @@ -1,8 +1,8 @@ {% callout %} -**Note** — `bunx` is an alias for `bun x` +**Note** — `bunx` is an alias for `bun x`. The `bunx` CLI will be auto-installed when you install `bun`. {% /callout %} -Use `bunx` to auto-install and run packages from `npm`. The `bunx` CLI will be auto-installed when you install `bun`. +Use `bunx` to auto-install and run packages from `npm`. It's Bun's equivalent of `npx` or `yarn dlx`. ```bash $ bunx cowsay "Hello world!" @@ -50,7 +50,7 @@ $ bunx my-cli --foo bar ## Shebangs -By default, Bun respects shebangs. If an executable is marked with `#!/usr/bin/env node`, Bun will spin up a `node` process to execute the file. However, in some cases it may be desirable to run executables using [Bun's runtime](/docs/runtime), even if the executable indicates otherwise. To do so, include the `--bun` flag. +By default, Bun respects shebangs. If an executable is marked with `#!/usr/bin/env node`, Bun will spin up a `node` process to execute the file. However, in some cases it may be desirable to run executables using Bun's runtime, even if the executable indicates otherwise. To do so, include the `--bun` flag. ```bash $ bunx --bun my-cli @@ -66,7 +66,7 @@ $ bunx my-cli --bun # bad {% /callout %} -## Environment variables +<!-- ## Environment variables Bun automatically loads environment variables from `.env` files before running a file, script, or executable. The following files are checked, in order: @@ -74,4 +74,4 @@ Bun automatically loads environment variables from `.env` files before running a 2. `NODE_ENV` === `"production"` ? `.env.production` : `.env.development` 3. `.env` -To debug environment variables, run `bun run env` to view a list of resolved environment variables. +To debug environment variables, run `bun run env` to view a list of resolved environment variables. --> |