diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/install/index.md | 9 | ||||
| -rw-r--r-- | docs/install/registries.md | 4 | ||||
| -rw-r--r-- | docs/installation.md | 12 |
3 files changed, 19 insertions, 6 deletions
diff --git a/docs/install/index.md b/docs/install/index.md index 48e001275..162a4abac 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -49,6 +49,12 @@ To install in production mode (i.e. without `devDependencies`): $ bun install --production ``` +To install dependencies without allowing changes to lockfile (useful on CI): + +```bash +$ bun install --frozen-lockfile +``` + To perform a dry run (i.e. don't actually install anything): ```bash @@ -80,6 +86,9 @@ peer = false # equivalent to `--production` flag production = false +# equivalent to `--frozen-lockfile` flag +frozenLockfile = false + # equivalent to `--dry-run` flag dryRun = false ``` diff --git a/docs/install/registries.md b/docs/install/registries.md index e4090e3c9..86657ca26 100644 --- a/docs/install/registries.md +++ b/docs/install/registries.md @@ -24,3 +24,7 @@ To configure a private registry scoped to a particular organization: # registry with token "@myorg3" = { token = "$npm_token", url = "https://registry.myorg.com/" } ``` + +### `.npmrc` + +Bun does not currently read `.npmrc` files. For private registries, migrate your registry configuration to `bunfig.toml` as documented above. diff --git a/docs/installation.md b/docs/installation.md index 06ca2b34d..9fce0b511 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -3,17 +3,17 @@ Bun ships as a single executable that can be installed a few different ways. {% callout %} **Windows users** — Bun does not currently provide a native Windows build. We're working on this; progress can be tracked at [this issue](https://github.com/oven-sh/bun/issues/43). In the meantime, use one of the installation methods below for Windows Subsystem for Linux. -**Linux users** — Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1. +**Linux users** — The `unzip` package is required to install Bun. Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1. {% /callout %} {% codetabs %} -```bash#Native -$ curl -fsSL https://bun.sh/install | bash # for macOS, Linux, and WSL +```bash#NPM +$ npm install -g bun # the last `npm` command you'll ever need ``` -```bash#npm -$ npm install -g bun # the last `npm` command you'll ever need +```bash#Native +$ curl -fsSL https://bun.sh/install | bash # for macOS, Linux, and WSL ``` ```bash#Homebrew @@ -26,7 +26,7 @@ $ docker pull oven/bun $ docker run --rm --init --ulimit memlock=-1:-1 oven/bun ``` -```bash#proto +```bash#Proto $ proto install bun ``` |