Xbps Operations

Manage XBPS packages and repositories. Note that XBPS package names are case-sensitive.

Facts used in these operations: xbps.XbpsPackages.

xbps.packages

Install/remove/update XBPS packages.

xbps.packages(packages: str | list[str] | None=None, present=True, update=False, upgrade=False, **kwargs)

  • packages: list of packages to ensure

  • present: whether the packages should be installed

  • update: run xbps-install -S before installing packages

  • upgrade: run xbps-install -y -u before installing packages

Example:

xbps.packages(
    name="Install Vim and Vim Pager",
    packages=["vimpager", "vim"],
)
Note:

This operation also inherits all global arguments.

xbps.update

Stateless operation

This operation will always execute commands and is not idempotent.

Update XBPS repositories.

xbps.update(**kwargs)
Note:

This operation also inherits all global arguments.

xbps.upgrade

Stateless operation

This operation will always execute commands and is not idempotent.

Upgrades all XBPS packages.

xbps.upgrade(**kwargs)
Note:

This operation also inherits all global arguments.