Skip to content

docs(bunx): add initial documentation to readme #2106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThatOneBro merged 1 commit into from
Feb 20, 2023
Merged

docs(bunx): add initial documentation to readme #2106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ bun upgrade --canary
- [What is the module ID hash?](#what-is-the-module-id-hash)
- [`bun upgrade`](#bun-upgrade)
- [`bun completions`](#bun-completions)
- [`bun x`](#bun-x)
- [`Bun.serve` - fast HTTP server](#bunserve---fast-http-server)
- [Usage](#usage-1)
- [HTTPS](#https-with-bunserve)
Expand Down Expand Up @@ -1862,6 +1863,20 @@ This command installs completions for `zsh` and/or `fish`. It runs automatically

If you want to copy the completions manually, run `bun completions > path-to-file`. If you know the completions directory to install them to, run `bun completions /path/to/directory`.

### `bun x`

This command runs a given binary from `npm`. It will look for the binary to run in any installed modules in the current file tree, and install the package in a temporary directory to run if its not available.

> Run vendor package
```bash
bun x vendor-package
```

> Run a specific version of vendor package
```bash
bun x [email protected]
```

## Loader API

Bun v0.1.11 introduces custom loaders.
Expand Down