diff options
| author |  Craigory Coppola <craigorycoppola@gmail.com>
| 2023-02-20 10:08:31 -0500 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-02-20 09:08:31 -0600 |
| commit | f6705a73c7aa3aa9d6be1c46324a8abcedb0b313 (patch) | |
| tree | 7790adaab6fddf031507d6ee09b7c1299b231ccd /README.md | |
| parent | 8bcf64c881447b29a96d272bc9af007c5fae9e01 (diff) | |
| download | bun-f6705a73c7aa3aa9d6be1c46324a8abcedb0b313.tar.gz bun-f6705a73c7aa3aa9d6be1c46324a8abcedb0b313.tar.zst bun-f6705a73c7aa3aa9d6be1c46324a8abcedb0b313.zip | |
docs(bunx): add initial documentation to readme (#2106)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -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) @@ -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 vendor-package@1.0.2 +``` + ## Loader API Bun v0.1.11 introduces custom loaders. |