meta_package_manager.managers.antigen module

meta_package_manager.managers.antigen.antigen_source_path()

Locate the antigen.zsh file every invocation sources.

Antigen documents no install location of its own: its README has the user curl -L git.io/antigen > antigen.zsh into a directory of their choosing, then source /path-to-antigen/antigen.zsh. Discovery is therefore best-effort over the two conventional spots plus $ADOTDIR, and a user who keeps it anywhere else simply leaves the manager unavailable rather than seeing it misbehave.

Falls back to the first candidate when none exists, so the built command stays well-formed and fails to source, which is what makes the version probe double as Antigen’s presence check.

Return type:

Path

class meta_package_manager.managers.antigen.Antigen

Bases: PackageManager

Antigen is a plugin manager for Zsh.

Bundles are declared in the user’s .zshrc with antigen bundle calls, then cloned under $ADOTDIR. Packages are identified by the short owner/repo name Antigen reports, which is the id mpm keys them on.

Caution

antigen is a shell function, not a standalone binary: it is defined by sourcing an antigen.zsh file, so it cannot serve as the manager’s CLI. Every invocation is therefore wrapped in zsh -c. Zsh is the binary mpm executes, and Antigen’s own presence is established by the version probe.

Unlike its siblings, Antigen documents no canonical install path, so antigen_source_path() can only guess at the conventional ones. A user who sources it from elsewhere leaves the manager unavailable.

Caution

No install: Antigen materializes exactly the bundle set the user’s own .zshrc declares. antigen bundle clones and loads a bundle for the current shell only, writing nothing back, so a package installed through mpm would vanish with the process. Installing one for real would mean mpm editing the user’s .zshrc, which is configuration mpm does not own.

Note

No outdated: Antigen compares nothing against its remotes short of performing the update. upgrade --all still works, and mpm auto-skips the operation.

Documentation: antigen.

Initialize cli_errors list.

name: str = 'Zsh Antigen'

Return package manager’s common name.

Default value is based on class name.

homepage_url: str | None = 'https://github.com/zsh-users/antigen'

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

logo: str | None = 'zsh'

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.

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='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='macos', name='macOS'), 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='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='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.

requirement: str | None = '>=2.0.0'

The 2.x series is where list, purge and update settled as the subcommands this class drives, alongside the $ADOTDIR layout.

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

Zsh is the binary mpm actually executes.

Antigen is a shell function defined by an antigen.zsh file that is sourced, never executed, so it cannot serve as the manager’s CLI: mpm requires an executable. Keying the manager on Zsh instead makes the version probe the presence check.

extra_env: ClassVar = {'NO_COLOR': '1', 'SHELL_SESSIONS_DISABLE': '1'}

SHELL_SESSIONS_DISABLE keeps macOS’ Zsh session bookkeeping from writing a session file on every query, as for Antidote.

version_cli_options: tuple[str, ...] = ('version',)

Antigen spells it as a subcommand: it defines an antigen-version function reached as antigen version, and recognizes no --version flag.

id: str = 'antigen'

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.

version_regexes: tuple[str, ...] = ('Antigen\\s+v?(?P<version>\\S+)',)

Antigen prints its release followed by the short commit it was built from.

The optional v absorbs the tag prefix its release builds carry. A copy taken from the development branch reports the literal string develop there instead of a version, which parses to nothing and correctly leaves the manager unavailable.

$ zsh -c 'source ~/antigen.zsh && antigen version'
Antigen v2.2.3 (0554db1)
Revision date: 2026-07-14 16:52:45 +0100

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.

build_cli(*args, **kwargs)

Wrap all CLI invocations in the Zsh shell Antigen needs.

The version probe is guarded by a readability test that exits successfully when antigen.zsh is absent. Zsh is the default shell on macOS and near ubiquitous elsewhere, so an unguarded probe would turn every host that merely has Zsh into a manager reporting errors.

Note

The **kwargs accepted by the base class (auto_pre_args, sudo, etc.) are accepted but ignored because every invocation goes through the zsh -c wrapper and Antigen never requires elevated privileges.

Return type:

tuple[str, ...]

property installed: Iterator[Package]

Fetch installed packages.

--simple is the listing format that prints one bare bundle name per line. Antigen’s default --short format appends @ <revision> to each, but that revision is the tracked branch (literally master for any bundle not pinned to one), not a version, so the simple form is what mpm parses.

$ zsh -c 'source ~/antigen.zsh && antigen list --simple'
zsh-users/zsh-syntax-highlighting
zsh-users/zsh-completions
zsh-users/zsh-history-substring-search

upgrade_all_cli()

Generates the CLI to upgrade all packages.

$ antigen update

Return type:

tuple[str, ...]

remove(package_id)

Remove one package.

purge drops the bundle’s clone from the filesystem. It leaves the user’s .zshrc untouched, so a bundle still declared there is cloned again by the next shell: the removal is of the installed copy, not of the declaration.

$ antigen purge zsh-users/zsh-completions --force

Return type:

str