`meta_package_manager.managers.guix` module¶

class meta_package_manager.managers.guix.Guix[source]¶

Bases: PackageManager

GNU Guix, GNU’s functional package manager.

Note

All operations target the current user’s default profile. Declarative system configuration (Guix System config.scm) is not covered.

Guix is a rolling release with no upstream semver to pin against: the guix of a fresh install reports its release, and once guix pull ran, the commit it was built from. No requirement floor is enforced, since any working guix will do.

Caution

sync runs guix pull, which outlasts the 500 second ceiling mpm puts on a state-changing command. A first pull authenticates the commit history of the channel, then builds Guix itself when no substitute is available yet: on an aarch64 virtual machine, it took 28 minutes. Raise the ceiling for this manager alone, in the configuration file:

[mpm.overrides.guix]
timeout = 3600

Note

guix pull builds a cache of the package set, so search answers in about a second. A guix run from a development checkout has no such cache and evaluates every package definition instead: there a search can outlast the 120 second ceiling of a read-only command, which kills it with no results.

Initialize cli_errors list.

name: str = 'GNU Guix'¶

Return package manager’s common name.

Default value is based on class name.

homepage_url: str | None = 'https://guix.gnu.org'¶

Home page of the project, only used in documentation for reference.

Left unset when the home page is the project’s repository, which repository_url names on its own, and when it is the project’s manual, which documentation_url names. Never inherited, like the other links.

documentation_url: str | None = 'https://guix.gnu.org/manual/en/html_node/Invoking-guix-package.html'¶

Entry point of the project’s own documentation, or None when it has none.

The manual, the documentation site, or the man page of the CLI mpm drives: whichever page a user reads to learn the commands this manager wraps. Listed between homepage_url and repository_url in the links of the manager’s page, so a reader reaching for the tool’s reference finds it in the box of facts rather than in the prose below it.

Left unset where a link would state a fact twice or invent one: a tool documenting itself in its repository alone, whose README repository_url already reaches. A page about the ecosystem rather than the tool does not qualify either.

Where a project’s only site is its manual, that address belongs here and homepage_url stays unset: the slot names what the page is, and a reader reaching for the reference looks under the documentation link.

Never inherited, like every other link: the AUR helpers extending pacman each document themselves.

repository_url: str | None = 'https://codeberg.org/guix/guix'¶

Repository holding the project’s code, or None when it has no public one.

Linked from the manager’s documentation page. Also what the weekly metrics sample reads: docs/docs_update.py writes it into the [tool.repomatic.metrics] subjects of pyproject.toml when its forge answers the sampler, through a mirror for a forge that does not.

Never inherited, for the same reason as wikipedia_url: the AUR helpers extending pacman each live in a repository of their own.

wikipedia_url: str | None = 'https://en.wikipedia.org/wiki/GNU_Guix'¶

English Wikipedia article about the project, or None when it has none.

Listed last in the links of the manager’s documentation page. The article covers the project that home page names, or is a redirect Wikipedia keeps under the project’s name, landing on the part of a broader article that describes it: Cargo_(software) opens the Cargo section of the Rust article. An article that merely mentions the project does not count, nor does one about a related subject: lazy is a Neovim plugin manager, and the Neovim article is not about it.

Never inherited: the metaclass resets it to None on any class not declaring its own. A subclass often wraps a distinct project, like the six AUR helpers extending pacman, and would otherwise present pacman’s article as its own. Documentation-only, like homepage_url.

logo: str | None = 'gnu'¶

Slug of the brand mark standing for this manager in the documentation.

Names an SVG vendored under docs/assets/managers/, whose provenance and license are recorded in docs/assets/managers/logos.yaml. Inlined at the top of the manager’s page by meta_package_manager._docs; a manager leaving it unset keeps the page’s default package glyph.

Several managers legitimately share one slug, either because they wrap the same upstream (brew and cask) or because the tool has no mark of its own and its ecosystem’s stands in (apt under Debian’s swirl, cargo under Rust’s gear). Documentation-only, like homepage_url: no CLI output reads it.

keywords: tuple[str, ...] = ('gnu guix',)¶

Well-known names for this manager that its id does not already carry.

Merged into the PyPI keywords of pyproject.toml by update_keywords() of docs/docs_update.py, alongside every manager ID and the globally curated KEYWORDS_EXTRAS. Declare an alias here rather than in that tuple whenever it names this manager: an alias living beside the class it describes cannot outlive it, where a central entry silently rots once the manager is renamed or dropped.

Reserve KEYWORDS_EXTRAS for terms belonging to no manager in particular, like cyclonedx or package manager. Documentation-only: no CLI output reads it.

Each keyword also becomes a content rule of the issue labeller, so its precision bar applies here: see generate_content_rules(). A subclass inherits the terms of its parent without claiming them, since test_manager_keywords_have_one_owner reads what a class declares itself.

platforms: frozenset[Platform] | Group | Platform | Iterable[Platform | Group] = frozenset({Platform(id='almalinux', name='AlmaLinux'), Platform(id='alpine', name='Alpine Linux'), Platform(id='altlinux', name='ALT Linux'), Platform(id='amzn', name='Amazon Linux'), Platform(id='android', name='Android'), Platform(id='arch', name='Arch Linux'), Platform(id='buildroot', name='Buildroot'), Platform(id='cachyos', name='CachyOS'), Platform(id='centos', name='CentOS'), Platform(id='chromeos', name='ChromeOS'), Platform(id='clearlinux', name='Clear Linux OS'), Platform(id='cloudlinux', name='CloudLinux OS'), Platform(id='crux', name='CRUX'), Platform(id='debian', name='Debian'), Platform(id='endeavouros', name='EndeavourOS'), Platform(id='exherbo', name='Exherbo Linux'), Platform(id='fedora', name='Fedora'), Platform(id='generic_linux', name='Generic Linux'), Platform(id='gentoo', name='Gentoo Linux'), Platform(id='guix', name='Guix System'), Platform(id='ibm_powerkvm', name='IBM PowerKVM'), Platform(id='kali', name='Kali Linux'), Platform(id='kvmibm', name='KVM for IBM z Systems'), Platform(id='linuxmint', name='Linux Mint'), Platform(id='mageia', name='Mageia'), Platform(id='mandriva', name='Mandriva Linux'), Platform(id='manjaro', name='Manjaro Linux'), Platform(id='nixos', name='NixOS'), Platform(id='nobara', name='Nobara'), Platform(id='nutyx', name='NuTyX'), Platform(id='opensuse', name='openSUSE'), Platform(id='openwrt', name='OpenWrt'), Platform(id='oracle', name='Oracle Linux'), Platform(id='parallels', name='Parallels'), Platform(id='pidora', name='Pidora'), Platform(id='pikaos', name='PikaOS'), Platform(id='raspbian', name='Raspbian'), Platform(id='rhel', name='RedHat Enterprise Linux'), Platform(id='rocky', name='Rocky Linux'), Platform(id='scientific', name='Scientific Linux'), Platform(id='slackware', name='Slackware'), Platform(id='sles', name='SUSE Linux Enterprise Server'), Platform(id='slitaz', name='SliTaz GNU/Linux'), Platform(id='solus', name='Solus'), Platform(id='sourcemage', name='Source Mage GNU/Linux'), Platform(id='tuxedo', name='Tuxedo OS'), Platform(id='ubuntu', name='Ubuntu'), Platform(id='ultramarine', name='Ultramarine'), Platform(id='void', name='Void Linux'), Platform(id='wsl1', name='Windows Subsystem for Linux v1'), Platform(id='wsl2', name='Windows Subsystem for Linux v2'), Platform(id='xenserver', name='XenServer')})¶

List of platforms supported by the manager.

Allows for a mishmash of platforms and groups of platforms. Will be normalized into a frozenset of Platform instances at instantiation.

version_regexes: tuple[str, ...] = ('guix \\(GNU Guix\\) (?P<version>\\d[\\w.\\-+]*)', 'guix \\(GNU Guix\\) (?P<version>[0-9a-f]{7,40})\\b')¶

$ guix --version
guix (GNU Guix) 1.5.0
Copyright (C) 2025 the Guix authors
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

property installed: Iterator[Package]¶

Fetch installed packages.

Columns are tab-separated: name, version, output and store path. Guix pads the first three with spaces, which are stripped. An output other than out is an entry of its own, reported as name:output: the specification that guix install and guix remove take back.

$ guix package --list-installed
hello           2.12.2  out     /gnu/store/8qjzxdk26p8c5nyj98s3321vbkmv9za0-hello-2.12.2
lua             5.1.5   out     /gnu/store/sq2sj9gj8bqzgv493249xd8gzhhw1f0x-lua-5.1.5
glib            2.83.3  out     /gnu/store/h95r1yvlbrlqap6l8fsdzp7lpxair7sv-glib-2.83.3
glib            2.83.3  bin     /gnu/store/06w4p65r8hli2qnsdsnp0l8r1zghz5qr-glib-2.83.3-bin
glib-networking 2.78.1  out     /gnu/store/n4nicicydz8d24m2qi3ddwlcxlr534qn-glib-networking-2.78.1

property outdated: Iterator[Package]¶

Fetch outdated packages.

guix upgrade --dry-run lists every package it would upgrade, and leaves the profile as it is.

Important

The report is written to <stderr> while <stdout> stays empty, so it is read from the recorded run.

$ guix upgrade --dry-run

The following packages would be upgraded:
   glib            2.83.3 → 2.86.0
   glib-networking 2.78.1 → 2.80.1
   glib:bin        2.83.3 → 2.86.0
   hello           2.12.2 → 2.12.3
   lua             5.1.5 → 5.5.0

22.6 MB would be downloaded

search(query, extended, exact)[source]¶

Fetch matching packages.

Caution

Search does not support extended or exact matching. So we return the best subset of results and let meta_package_manager.manager.PackageManager.refiltered_search() refine them.

Guix keeps some packages in several versions under one name, like lua from 5.1.5 to 5.4.8. A name is reported once, at its newest version: the one guix install picks.

A query naming an output, like glib:bin, reports that output of the package of that exact name. That is the form installed reports, and mpm install searches for a package before it installs it.

Results are printed in recutils format with records separated by blank lines.

$ guix search cowsay
name: cowsay
version: 3.8.4
outputs:
+ out: everything
systems: x86_64-linux mips64el-linux aarch64-linux powerpc64le-linux
+ i686-linux armhf-linux powerpc-linux
dependencies: perl@5.36.0
location: gnu/packages/games.scm:1431:2
homepage: https://web.archive.org/web/20071026043648/http://www.nog.net:80/~tony/warez/cowsay.shtml
license: GPL 3+
synopsis: Speaking cow text filter
description: Cowsay is basically a text filter.  Send some text into it, and
+ you get a cow saying your text.  If you think a talking cow isn't enough, cows
+ can think too: all you have to do is run `cowthink'.  If you're tired of cows,
+ a variety of other ASCII-art messengers are available.
relevance: 32

name: python-snakesay
version: 0.10.4
outputs:
+ out: everything
systems: x86_64-linux mips64el-linux aarch64-linux powerpc64le-linux
+ i686-linux armhf-linux powerpc-linux
dependencies: python-pytest@8.4.1 python-setuptools@80.9.0
location: gnu/packages/python-xyz.scm:2293:2
homepage: https://github.com/pythonanywhere/snakesay
license: Expat
synopsis: Like `cowsay' but with Python flavor
description: This package provides a simple ASCII art pictures generator of a
+ Snake with a message.
relevance: 3

Return type:: Iterator[Package]

install(package_id, version=None)[source]¶

Install one package.

$ guix install hello

Return type:: str

cli_names: tuple[str, ...] = ('guix',)¶

List of CLI names the package manager is known as.

This list of recognized CLI names is ordered by priority. That way we can influence the search of the right binary.

..hint::: This was helpful in the case of the Python transition from 2.x to 3.x, where multiple versions of the same executable were named python or python3.

By default, this property’s value is derived from the manager’s ID (see the MetaPackageManager.__init__ method above).

id: str = 'guix'¶

Package manager’s ID.

Derived by defaults from the lower-cased class name in which underscores _ are replaced by dashes -.

This ID must be unique among all package manager definitions and lower-case, as they’re used as feature flags for the mpm CLI.

upgrade_all_cli()[source]¶

Generates the CLI to upgrade all packages.

$ guix upgrade

Return type:: tuple[str, ...]

virtual: bool = False¶

Should we expose the package manager to the user?

Virtual package manager are just skeleton classes used to factorize code among managers of the same family.

upgrade_one_cli(package_id, version=None)[source]¶

Generates the CLI to upgrade one package.

guix upgrade reads its argument as a regular expression, and upgrades every installed package whose name it matches: guix upgrade glib also upgrades glib-networking. So the name is escaped and anchored, to match itself alone. Entries match by name, so the :output suffix is dropped, and every installed output of the package is upgraded.

$ guix upgrade ^lua$

Return type:: tuple[str, ...]

remove(package_id)[source]¶

Remove one package.

$ guix remove hello

Return type:: str

sync()[source]¶

Fetch the latest Guix channel revisions.

$ guix pull

Return type:: None

cleanup_cache()[source]¶

Collect garbage in the store.

$ guix gc

Return type:: None

meta_package_manager.managers.guix module¶

`meta_package_manager.managers.guix` module¶