bdep-clean(1)

💖 bdep-clean(1) 💖

okay bestie, welcome to bdep-clean, straight outta the General Commands Manual section of the bdep fam. sit down, grab a boba, we're cleaning some build configs and we're gonna have fun doing it 🧹✨

---

✨ NAME ✨

bdep-clean — clean project in build configurations 🧼

---

🦋 SYNOPSIS 🦋

bdep clean [options] [pkg-spec] [cfg-spec] [cfg-var...]

cfg-spec = (@cfg-name | --config|-c cfg-dir)... | --all|-a
pkg-spec = (--directory|-d pkg-dir)... | prj-spec
prj-spec = --directory|-d prj-dir

like, it's giving "I have a command and I know how to use it" 💅

---

🌸 DESCRIPTION 🌸

so the clean command cleans the project packages in one or more build configurations. no cap. and if you want it to go deeper, you can clean the immediate or all dependencies of the project packages by passing --immediate|-i or --recursive|-r respectively. obsessed. 💖

underneath, clean executes the bpkg-pkg-clean(1) command, which itself is honestly not much more than the build system clean operation (peep b(1) for the details, iykyk). so the main character energy of this command is that it lets you refer to build configurations by their names, refer to project packages implicitly via the current working directory, and clean dependencies. iconic behaviour, honestly. 👑

if no project or package directory is specified, then the current working directory is assumed — like, it just knows. and if no configuration is specified, then the default configurations are assumed. see bdep-projects-configs(1) for the whole rundown on specifying projects and configurations. the optional cfg-var... are the additional configuration variables to pass to the build system. 🎀

---

🎀 CLEAN OPTIONS 🎀

• --immediate|-i — also clean immediate dependencies. it's giving thorough ✨
• --recursive|-r — also clean all dependencies, recursively. go all the way down, bestie, no half measures 💀
• --all|-a — use all build configurations. every single one. 🌈
• --config|-c dir — specify the build configuration as a directory.
• --directory|-d dir — assume project/package is in the specified directory rather than in the current working directory. 🙈
• --config-name|-n name — specify the build configuration as a name.
• --config-id num — specify the build configuration as an id.

---

💜 COMMON OPTIONS 💜

these are all summarised below, and the full lore drop lives in bdep-common-options(1). go read it, bestie, it's a vibe. 📖

• -v — print essential underlying commands being executed.
• -V — print all underlying commands being executed. every last one, we love a transparent king 👑
• --quiet|-q — run quietly, only printing error messages. silent mode activated 🤫
• --verbose level — set the diagnostics verbosity to level between 0 and 6.
• --stdout-format format — representation format to use for printing to stdout.
• --jobs|-j num — number of jobs to perform in parallel. multitasking slay 💅
• --progress — display progress indicators for long-lasting operations, such as network transfers, building, etc.
• --no-progress — suppress progress indicators for long-lasting operations, such as network transfers, building, etc.
• --diag-color — use color in diagnostics. 🌈
• --no-diag-color — don't use color in diagnostics.
• --bpkg path — the package manager program to be used for build configuration management.
• --bpkg-option opt — additional option to be passed to the package manager program.
• --build path — the build program to be used to build packages.
• --build-option opt — additional option to be passed to the build program.
• --curl path — the curl program to be used for network operations.
• --curl-option opt — additional option to be passed to the curl program.
• --pager path — the pager program to be used to show long text.
• --pager-option opt — additional option to be passed to the pager program.
• --options-file file — read additional options from file.
• --default-options dir — the directory to load additional default options files from.
• --no-default-options — don't load default options files.

---

🫶 DEFAULT OPTIONS FILES 🫶

check bdep-default-options-files(1) for the whole overview of the default options files, bestie. for the clean command, the search start directory is the project directory. 📁

these options files get searched for in each directory and, if found, loaded in the order listed:

bdep.options
bdep-clean.options

and bestie, listen — the following clean command options cannot be specified in the default options files:

• --directory|-d

🚨 like fr fr, don't try it. it's not happening.

---

😭 BUGS 😭

found a bug? send bug reports to the users@build2.org mailing list. we're listening, we promise 🫶

---

⭐ COPYRIGHT ⭐

Copyright (c) 2014-2024 the build2 authors.

Permission is granted to copy, distribute and/or modify this document under the terms of the MIT License.

---

and that's the whole page, bestie!! 🎀 this lil' slice of bdep 0.17.0 dropped way back in June 2024, and it's still serving. stay clean, stay iconic, mwah 💋✨