aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/install
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-08-03 16:31:05 -0700
committerGravatar GitHub <noreply@github.com> 2023-08-03 16:31:05 -0700
commit112030481f3d89bb45cf9cecb2b21530bb53398c (patch)
treee2d57f7bd56179a2c6d84c4a7a18ef59b59f660a /docs/guides/install
parent9574db355f1435f60214726b21f1ca5bb9d13f6c (diff)
downloadbun-112030481f3d89bb45cf9cecb2b21530bb53398c.tar.gz
bun-112030481f3d89bb45cf9cecb2b21530bb53398c.tar.zst
bun-112030481f3d89bb45cf9cecb2b21530bb53398c.zip
More guides and fixing links (#3960)bun-v0.7.2
* More guides * WIP * Updates * Fix
Diffstat (limited to 'docs/guides/install')
-rw-r--r--docs/guides/install/yarnlock.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/guides/install/yarnlock.md b/docs/guides/install/yarnlock.md
new file mode 100644
index 000000000..898df634d
--- /dev/null
+++ b/docs/guides/install/yarnlock.md
@@ -0,0 +1,42 @@
+---
+name: Generate a human-readable lockfile
+---
+
+By default Bun generates a binary `bun.lockb` file when you run `bun install`. In some cases, it's preferable to generate a human-readable lockfile instead.
+
+---
+
+Use the `--yarn` flag to generate a Yarn-compatible `yarn.lock` file (in addition to `bun.lockb`).
+
+```sh
+$ bun install --yarn
+```
+
+---
+
+To set this as the default behavior, add the following to your `bunfig.toml` file.
+
+```toml#bunfig.toml
+[install]
+print = "yarn"
+```
+
+---
+
+To print a Yarn lockfile to your console without writing it to disk, just "run" your `bun.lockb` with `bun`.
+
+```sh
+$ bun bun.lockb
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+# bun ./bun.lockb --hash: 9BFBF11D86084AAB-9418b03ff880c569-390CE6459EACEC9A...
+
+abab@^2.0.6:
+ version "2.0.6"
+ resolved "https://registry.npmjs.org/abab/-/abab-2.0.6.tgz"
+ integrity sha512-j2afSsaIENvHZN2B8GOpF566vZ5WVk5opAiMTvWgaQT8DkbOqsTfvNAvH...
+```
+
+---
+
+See [Docs > Package manager](/docs/cli/install) for complete documentation of Bun's package manager.