aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/install/add-optional.md
blob: 6d02c23e20708a07f61be8619b8b2ceb523bb576 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
---
name: Add an optional dependency
---

To add an npm package as a peer dependency, use the `--optional` flag.

```sh
$ bun add zod --optional
```

---

This will add the package to `optionalDependencies` in `package.json`.

```json-diff
{
  "optionalDependencies": {
+   "zod": "^3.0.0"
  }
}
```

---

See [Docs > Package manager](/docs/cli/install) for complete documentation of Bun's package manager.