Command reference

All actions use the selected profile/runtime. Required inputs appear in the command dialog. Some operations need a capability of the project's Yocto release (see Release capabilities). Bitloom checks it in the project itself (the class in its layers, the tool in its BitBake) and falls back to the release number; where it is missing the TUI, the web dashboard and --ci refuse the operation, say why and name the one to use instead.

Interactive commands hand off to a real terminal and are not stored as queued build logs. Custom task adds -c TASK after the target. kas commands append the selected kas_file.

Action-specific requirements#

• Clean recipe + sstate: Removes this recipe's local shared state. Avoid with shared caches in active use.
• Clean recipe + sstate + downloads: Removes recipe sources and local shared state.
• Generate SPDX SBOM: Requires create-spdx in your image configuration.
• Run image tests: Requires testimage configuration and suitable target runner.
• Build ptest packages: Recipe must inherit ptest and ptest must be enabled.
• Custom command (argument list): Parsed as argv. Shell operators are not interpreted.
• Save kernel defconfig: Writes a minimal defconfig of the current kernel configuration to the kernel's build folder (${B}/defconfig): copy it to your layer as a starting point.
• U-Boot menuconfig: Configures the machine's bootloader (PREFERRED_PROVIDER_virtual/bootloader, usually u-boot) in a terminal. Keep the result with U-Boot diffconfig.
• Export U-Boot config changes: Writes the changes made with menuconfig as a fragment.cfg in the bootloader's work folder: add it to SRC_URI in a u-boot append in your layer.
• Run recipe CVE check (cve-check): Requires the cve-check class and CVE database. Removed in 6.0 Wrynose: use sbom-cve-check.
• Recipe CVE analysis from its SBOM (sbom-cve-check): Analyses the recipe SBOM without building the software. The recipe must inherit sbom-cve-check-recipe; reports go to DEPLOY_DIR_IMAGE.
• Create recipe SBOM (SPDX 3): Recipe-level SBOM used by sbom-cve-check-recipe.
• Generate VEX metadata: Requires INHERIT += "vex". Produces per-recipe and image VEX reports in DEPLOY_DIR_IMAGE.
• Enable sbom-cve-check for image builds: Every image build then analyses its SPDX 3 SBOM for CVEs. Reports go to DEPLOY_DIR_IMAGE.
• List configuration fragments: Fragments are named pieces of configuration (machine/…, distro/…, core/yocto/…) enabled in conf/toolcfg.conf.
• Enable a configuration fragment: Appends the fragment to OE_FRAGMENTS in build/conf/toolcfg.conf, for example core/yocto/sstate-mirror-cdn.
• bitbake-setup: compare with upstream: Shows how this bitbake-setup workspace differs from its configuration template and upstream layers.
• bitbake-setup: update layers and configuration: Brings the workspace to its template: updates layer checkouts and, after asking, the build configuration.

Release capabilities#

One registry (bitloom/capabilities.py) decides what the project's Yocto release can do. Operations, SBOM and CRA settings, the CRA checks and Studio all ask it. Evidence is looked for in the project first; the release window is used only when the layers or BitBake are not visible from Bitloom. Configuration shows the answer for the active project (web: What this release can do).