aboutsummaryrefslogtreecommitdiff
path: root/docs/cli/bun-completions.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/cli/bun-completions.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/cli/bun-completions.md b/docs/cli/bun-completions.md
new file mode 100644
index 000000000..68dcb946d
--- /dev/null
+++ b/docs/cli/bun-completions.md
@@ -0,0 +1,3 @@
+This command installs completions for `zsh` and/or `fish`. It runs automatically on every `bun upgrade` and on install. It reads from `$SHELL` to determine which shell to install for. It tries several common shell completion directories for your shell and OS.
+
+If you want to copy the completions manually, run `bun completions > path-to-file`. If you know the completions directory to install them to, run `bun completions /path/to/directory`.