Skip to main content

xbstrap: Build system for OS distributions

xbstrap is a build system designed to build "distributions" consisting of multiple (usually many) packages. It does not replace neither make and ninja nor autoconf, automake, meson or cmake and similar utilities. Instead, xbstrap is intended to invoke those build systems in the correct order, while respecting inter-package dependencies.

Official Discord server: https://discord.gg/7WB6Ur3

Installation

xbstrap is available from PyPI. To install it using pip, use:

pip3 install xbstrap

Basic usage

See the boostrap-managarm repository for an example bootstrap.yml file.

Installing all tools (that run on the build system) is done using:

xbstrap install-tool --all

Installing all packages to a sysroot (of the host system):

xbstrap install --all

It is often useful to rebuild specific packages. Rebuilding package foobar can be done by:

xbstrap install --rebuild foobar

If the configure script shall be run again, use instead:

xbstrap install --reconfigure foobar

Local development

When developing xbstrap, you must install your local copy instead of the one provided by the pip repositories. To do this, run:

pip install --user -e .

Development with Docker

For containerized builds, most xbstrap commands will run in two stages: once on the host, then again on the container to actually execute the build steps. Therefore, installing xbstrap locally (as shown above) is not sufficient in this case.

In addition, you must change your Dockerfile so that instead of grabbing xbstrap from the pip repositories, it installs from the host:

  1. Add the following lines (replace /local-xbstrap at your convenience):
ADD xbstrap /local-xbstrap
RUN pip3 install -e /local-xbstrap
  1. Copy or symlink your local xbstrap into the same folder that contains the Dockerfile, so that it can be accessed by the previous step.
  2. Rebuild the docker container as usual.

Enabling the pre-commit hook for linting (optional)

To avoid running into the CI complaining about formatting, linting can be done in a pre-commit hook. To enable this, run:

git config core.hooksPath .githooks

Metadata

Release files for xbstrap 0.36

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xbstrap 0.36
File Size Uploaded
xbstrap-0.36.tar.gz 56.2 kB Details

Release files / xbstrap-0.36.tar.gz

Download URL xbstrap-0.36.tar.gz
Size 56.2 kB
Tags Source
SHA-256 checksum
How to use checksums
93e57ee5510ff3a35df7d30af46e73a3ef81ec8159daf868de61825212abdc64
BLAKE2b-256 checksum
How to use checksums
e0471fb34b645e3e1840348ca216c7c4d23416c3051f7183b62dae201068c05d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

0.36 This release

1 release file

0.35

1 release file

0.34.2

1 release file

0.34.1

1 release file

0.34

1 release file

0.33

1 release file

0.32.1

1 release file

0.32

1 release file

0.31.3

1 release file

0.31.2

1 release file

0.31.1

1 release file

0.31

1 release file

0.30

1 release file

0.29

1 release file

0.28

1 release file

0.27.1

1 release file

0.27.0

1 release file

0.26

1 release file

0.25.3

1 release file

0.25.2

1 release file

0.25.1

1 release file

0.25

1 release file

0.24

1 release file

0.23.2

1 release file

0.23.1

1 release file

0.23

1 release file

0.22

1 release file

0.21

1 release file

0.20

1 release file

0.19.3

1 release file

0.19.2

1 release file

0.19.1

1 release file

0.19

1 release file

0.18

1 release file

0.17

1 release file

0.16

1 release file

0.15

1 release file

0.14.1

1 release file

0.14

1 release file

0.13.1

1 release file

0.13

1 release file

0.12

1 release file

0.11

1 release file

0.10

1 release file

0.9.1

1 release file

0.9

1 release file

0.8

1 release file

0.7

1 release file

0.6

1 release file

0.5

1 release file

0.4

1 release file

0.3

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page