bpkg(1)

📦
version 0.17.0 · 2 versions
, in fedora 43, fedora 44, nixos 26.05

💖 bpkg — the build2 package dependency manager 💖

hey bestie 👋 so this is the manual page for bpkg, from the General Commands Manual section. it's the package dependency manager that ships with build2, and honestly? she does a LOT. let's get into it 🫶

✨ NAME ✨

bpkg — package dependency manager 💅

🌸 SYNOPSIS 🌸

bpkg --help
bpkg --version
bpkg help [command | topic]
bpkg [common-options] command [command-options] command-args

🦋 DESCRIPTION 🦋

The build2 package dependency manager is what you use to manipulate build configurations, packages, and repositories, using a whole lil set of commands that are summarized below. ⭐

Want the full tea on any command or help topic? use the help command, or go read the matching man page — those have the bpkg- prefix, like bpkg-help(1). 🎀 Also note that command-options and command-args can be specified in any order, and common-options can be specified as part of command-options. slay, flexible.

🎀 what even IS a build configuration

A bpkg build configuration is a directory that contains packages built with similar settings. Like, a configuration could be for a specific target (i686, x86_64), compiler (clang, gcc) compile options (-O3, -g), and so on. Configurations are relatively cheap and can be created and thrown away as needed. 💸

Configurations can be moved and copied by simply moving and copying the directories. Note, however, that a move or copy may render some packages out-of-date. 😭 In the build2 build system terms, a bpkg build configuration is an amalgamation that contains packages as subprojects — see bpkg-cfg-create(1) for details.

Build configurations can be linked with each other so that while a package is built in one configuration, some of its dependencies can be built in linked configurations (again, bpkg-cfg-create(1) for the deets). 🔗

🍓 packages and repositories

A bpkg package is an archive or directory (potentially in a version control system) that contains a build2 project plus the package manifest file. bpkg can either use package archives/directories directly from the filesystem, or it can fetch them from repositories. 🧺

A bpkg repository is a collection of packages as well as information about prerequisite and complement repositories. Archive, directory and version control-based repositories are supported. A repository is identified by its location, which can be a local filesystem path or a URL. See bpkg-repository-types(1) for details on the repository structures and URL formats. 🌈

If the same version of a package is available from multiple repositories, then they are assumed to contain identical package content. In such cases bpkg prefers local repositories over remote, and among local repositories it prefers the ones with external packages (see bpkg-pkg-unpack(1) for details on external packages). 👑

💫 a typical bpkg workflow

Here's what a normal bpkg glow-up sequence looks like:

Create Configuration

bpkg create cc                   \
  config.cxx=clang++             \
  config.cc.coptions=-O3         \
  config.install.root=/usr/local \
  config.install.sudo=sudo

Add Source Repositories

bpkg add https://pkg.cppget.org/1/stable
bpkg add https://example.org/foo.git

Repeat this command to add more repositories. 🔁

Fetch Available Packages List

bpkg fetch

Fetch and Build Packages

bpkg build foo bar

Drop Package

If some packages are no longer needed, we can remove them from the configuration.

bpkg drop foo

Refresh Available Packages List

bpkg fetch

Upgrade Packages

bpkg build bar

Install Packages

bpkg install bar

👑 COMMANDS 👑

💜 HELP TOPICS 💜

✨ COMMON OPTIONS ✨

The common options are summarized below — and there's a way more detailed description available in bpkg-common-options(1). 📚

  • -v — Print essential underlying commands being executed.
  • -V — Print all underlying commands being executed.
  • --quiet, -q — Run quietly, only printing error messages. 🤫
  • --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.
  • --no-result — Don't print informational messages about the outcome of performing a command or some of its parts.
  • --structured-result fmt — Write the result of performing a command in a structured form.
  • --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.
  • --build path — The build program to be used to build packages.
  • --build-option opt — Additional option to be passed to the build program.
  • --fetch path — The fetch program to be used to download resources.
  • --fetch-option opt — Additional option to be passed to the fetch program.
  • --fetch-timeout sec — The fetch and fetch-like (for example, git) program timeout.
  • --pkg-proxy url — HTTP proxy server to use when fetching package manifests and archives from remote pkg repositories.
  • --git path — The git program to be used to fetch git repositories.
  • --git-option opt — Additional common option to be passed to the git program.
  • --sha256 path — The sha256 program to be used to calculate SHA256 sums.
  • --sha256-option opt — Additional option to be passed to the sha256 program.
  • --tar path — The tar program to be used to extract package archives.
  • --tar-option opt — Additional option to be passed to the tar program.
  • --openssl path — The openssl program to be used for crypto operations.
  • --openssl-option opt — Additional option to be passed to the openssl program.
  • --auth type — Types of repositories to authenticate.
  • --trust fingerprint — Trust repository certificate with a SHA256 fingerprint.
  • --trust-yes — Assume the answer to all authentication prompts is yes.
  • --trust-no — Assume the answer to all authentication prompts is no.
  • --git-capabilities up=pc — Protocol capabilities (pc) for a git repository URL prefix (up).
  • --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.
  • --keep-tmp — Don't remove the bpkg's temporary directory at the end of the command execution and print its path at the verbosity level 2 or higher.

🌿 ENVIRONMENT 🌿

Commands executed by bpkg while the current and linked build configuration databases are open will have the BPKG_OPEN_CONFIGS environment variable set to the space-separated, "-quoted list of absolute and normalized configuration directory paths. This can be used by build system hooks and/or programs that they execute. 🫶

💀 EXIT STATUS 💀

  1. 0 — Success. 🎉
  2. 1 — Fatal error.
  3. 2 — Recoverable error which is likely to disappear if the command is re-executed.

🌈 ENVIRONMENT (yes, again bestie) 🌈

The BPKG_DEF_OPT environment variable is used to suppress loading of default options files in nested bpkg invocations. Its values are false or 0 to suppress, and true or 1 to load. 💅

🐛 BUGS 🐛

Send bug reports to the users@build2.org mailing list. 📬

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.

okay that's the whole page, no cap ✨ this was bpkg 0.17.0, dated June 2024 — literally iconic, obsessed, periodt 💖🎀🦋

📦 where this page comes from