aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/install/yarnlock.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/install/yarnlock.md')
-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.