CMDLINER-INS...L-COMPLETION(1)

💅 cmdliner-install-tool-completion(1) — like, the Cmdliner Manual bestie ✨

okay so real talk, this is a page from the Cmdliner Manual and it's all about cmdliner-install-tool-completion, which is genuinely one of those commands that just works so you don't have to. let's get into it 🫶

---

🌸 NAME 🌸

cmdliner-install-tool-completion — installs tool completion scripts. that's it, that's the vibe. ✨

---

🎀 SYNOPSIS 🎀

cmdliner install tool-completion [OPTION]… TOOLNAME… SHAREDIR

---

🦋 DESCRIPTION 🦋

so cmdliner install tool-completion is the main character here: it installs the tool completion script(s) for whatever tools and shells you hand it, into a share directory, and it follows the specific conventions each shell expects. directories get created if they don't exist already — no cap, it just does it. 💖

want to peek before committing? use the --dry-run option and it'll show you which paths would be written. iconic. example time:

cmdliner install tool-completion mytool /usr/local/share  # All supported shells
cmdliner install tool-completion --shell zsh mytool /usr/local/share

heads up bestie 🙈 — the command install tool-support also installs completions, same as this command does. and if you want to actually inspect the scripts (not install them), use the tool-completion command instead. iykyk.

---

👑 ARGUMENTS 👑

⭐ SHAREDIR (required)

SHAREDIR is literally just the share directory you're installing to. that's the whole job.

⭐ TOOLNAME (required)

TOOLNAME is the name of the tool you want to complete. and yes, it's repeatable — go off, list as many as you want 💅

---

✨ OPTIONS ✨

• --dry-run — do not install anything, just output the paths that would be written. a little preview moment, we love to see it 👀
• -s SHELL, --shell=SHELL (absent = All supported shells) — the shell you want to support. it must be one of bash, zsh or pwsh. repeatable, so you can stack 'em up 🧚
• --standalone-completion — generates standalone completion scripts. these scripts do not depend on the generic cmdliner completion scripts. fair warning though: for some shells this may result in slower completion 😭 (tradeoff queen)
• --update-opam-install=PKG.install — updates or creates an opam .install file PKG.install, with install moves going from the installed files to the corresponding opam install sections. and yes, this also happens if --dry-run is specified. slay 🍓

---

🌈 COMMON OPTIONS 🌈

• --help[=FMT] (default = auto) — shows this help in format FMT. FMT must be one of auto, pager, groff or plain. with auto, the format is pager or plain whenever the TERM env var is dumb or undefined. (env var respecting behavior, we stan 💜)
• --version — shows version information. periodt.

---

💀 EXIT STATUS 💀

cmdliner install tool-completion exits with:

1. 0 — on success. we love a clean win ✨
2. 123 — on indiscriminate errors reported on standard error.
3. 124 — on command line parsing errors.
4. 125 — on unexpected internal errors (bugs). not me filing a bug report 😭

---

🔥 SEE ALSO 🔥

cmdliner(1) — go read that one too, bestie 🫶

---

and that's the whole page, fr fr — no notes 💖

okay so final sign-off: this gem is Cmdliner v2.1.1 and it lives in the Cmdliner Manual. go forth and complete all the things 👑✨🎀