aboutsummaryrefslogtreecommitdiff
path: root/docs/cli/install.md
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-09-21 15:17:16 -0700
committerGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-09-21 15:17:16 -0700
commitcfc56dafeb18042f4f4144127e02ffd2da3273df (patch)
treed2888795992af30a8411e0ff6d5199a3ad3af981 /docs/cli/install.md
parentb011f94250030858c28cc4338f18b46d3ae26dc9 (diff)
downloadbun-cfc56dafeb18042f4f4144127e02ffd2da3273df.tar.gz
bun-cfc56dafeb18042f4f4144127e02ffd2da3273df.tar.zst
bun-cfc56dafeb18042f4f4144127e02ffd2da3273df.zip
Update install docs
Diffstat (limited to 'docs/cli/install.md')
-rw-r--r--docs/cli/install.md20
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/cli/install.md b/docs/cli/install.md
index 4aa4e7816..9aafae301 100644
--- a/docs/cli/install.md
+++ b/docs/cli/install.md
@@ -23,9 +23,7 @@ sudo apt install --install-recommends linux-generic-hwe-20.04
{% /details %}
-## Manage dependencies
-
-### `bun install`
+## `bun install`
To install all dependencies of a project:
@@ -95,7 +93,7 @@ dryRun = false
{% /details %}
-### `bun add`
+## `bun add`
To add a particular package:
@@ -177,7 +175,7 @@ To view a complete list of options for a given command:
$ bun add --help
```
-### `bun remove`
+## `bun remove`
To remove a dependency:
@@ -185,7 +183,17 @@ To remove a dependency:
$ bun remove preact
```
-## Local packages (`bun link`)
+## `bun update`
+
+To update all dependencies to the latest version _that's compatible with the version range specified in your `package.json`_:
+
+```sh
+$ bun update
+```
+
+This will not edit your `package.json`. There's currently no command to force-update all dependencies to the latest version regardless version ranges.
+
+## `bun link`
Use `bun link` in a local directory to register the current package as a "linkable" package.