CH-COMPLETION.BASH(7)

✨ ch-completion.bash(7) ✨

okay bestie, this is the manual page for ch-completion.bash, living in the Charliecloud part of your man pages. it's the glow-up that makes your terminal go tab tab tab and magically finish your Charliecloud commands. you're gonna love her. 💅

---

🌸 NAME 🌸

ch-completion.bash — Tab completion for the Charliecloud command line

---

🦋 SYNOPSIS 🦋

$ source ch-completion.bash

---

💖 DESCRIPTION 💖

ch-completion.bash provides tab completion for the charliecloud command line. Right now, bestie, tab completion is available for Bash users, and it covers these three executables: ch-image, ch-run, and ch-convert. that's it, that's the trio, and they're all getting the autocomplete treatment. 👑

so here's the awkward part: if Charliecloud is built from source, we do not currently install the file (see issue #1842 at https://github.com/hpc/charliecloud/issues/1842 😭). in that case, just source it straight from the Charliecloud source code like so:

$ source $CHARLIECLOUD_SOURCE_PATH/bin/ch-completion.bash

if you installed with a distribution package, the procedure is probably nicer. (peep your distro's docs if you installed a package.)

and if you ever wanna turn it off? there's a utility function called ch-completion that gets added to your environment the moment you source the thing above. so:

$ ch-completion --disable

poof, no more completion. ✨

---

🎀 DEPENDENCIES 🎀

tab completion has a couple of extra dependencies, no cap:

• Bash ≥ 4.3.0 🐚
• the bash-completion library (GitHub: https://github.com/scop/bash-completion, or tbh it probably comes with your distribution, e.g. https://packages.debian.org/bullseye/bash-completion) 📦

---

💜 CH-COMPLETION 💜

Utility function for ch-completion.bash.

⭐ Synopsis ⭐

$ ch-completion [ OPTIONS ]

🌈 Description 🌈

ch-completion is a function that manages Charliecloud's tab completion. it gets added to your environment when completion is sourced, which is lowkey so convenient. the option(s) you pass in tell it what to do:

• --disable — Disable tab completion for all Charliecloud executables. bye bye autocomplete 💀
• --help — Print help message. the classic, she's always there for you 🫶
• --version — Print version of tab completion that's currently enabled.
• --version-ok — Verify that tab completion version is consistent with that of ch-image. (vibe check for your versions ✅)

---

🔥 DEBUGGING 🔥

tab completion can write debugging logs to /tmp/ch-completion.log. enable this by setting the environment variable CH_COMPLETION_DEBUG. (this is primarily intended for developers, so if you're just vibing with tab completion, you can skip this one 🙈)

---

👑 Copyright 👑

contributors to the Charliecloud project, which has been established as "Charliecloud a Series of LF Projects, LLC". For web site terms of use, trademark policy, and related information, please see: https://lfprojects.org.

---

and that's the whole page, bestie!! 🎀 this was ch-completion.bash(7), version 0.44, dated 2026-05-31 07:53 UTC — she ate and left no crumbs, fr fr. now go tab-complete something iconic. 🌟💖