meta_package_manager.managers.vagrant module

class meta_package_manager.managers.vagrant.Vagrant

Bases: PackageManager

Vagrant’s box manager, covering the base images it fetches from its registry.

Vagrant orchestrates virtual machines, which is not package management. Two of its subcommand trees are: vagrant box, covering versioned base images pulled from a registry, and vagrant plugin, covering Vagrant’s own extensions. Only one can be the inventory, and boxes are it. They carry the whole operation set, where plugins offer neither an outdated nor a search of any kind, and a plugin is a RubyGem installed into a private gem home rather than something with a registry of its own.

A package is a box, identified by the bare name the listing prints, which may be a registry name like ubuntu/jammy64, a purely local name, or a full URL. The provider and the architecture are deliberately dropped from the identifier.

Note

That last point is what makes this a class rather than a definition. Vagrant lists one row per (name, provider, version) triple, so a box installed in three versions appears three times, and the same is true of the outdated report. mpm keys a package on its id alone, so both listings are reduced here to one entry per name, keeping the newest version installed.

Caution

Every box command reads the registry under ~/.vagrant.d and needs no Vagrantfile, with two exceptions that are avoided rather than handled: vagrant box outdated inspects only the boxes the current directory’s Vagrantfile declares unless --global is passed, and vagrant box update is scoped the same way unless --box names one. Both forced flags are therefore load-bearing: without them the answer would depend on where mpm happened to be invoked, and would fail outright outside a Vagrant project.

One piece of ambient state cannot be escaped: Vagrant evaluates the Vagrantfile’s trigger configuration on every subcommand, so a malformed Vagrantfile in the working directory breaks even box list. Only the version probe is immune.

Note

No upgrade --all: Vagrant has no command that updates every installed box, box update addressing either one named box or the current project’s. mpm backfills it from outdated plus the per-box upgrade instead.

No sync either, there being no command that refreshes box metadata without also downloading, and the machine-readable output mode is unusable for boxes: it emits four lines per box with an empty target column, so nothing correlates them back into a record.

Documentation: Vagrant boxes.

Initialize cli_errors list.

maintenance_note: str | None = 'Upstream has slowed: the last stable release is `2.4.9` of August 2025, though the repository is still committed to. Note also that Vagrant is distributed under the Business Source License from `2.4.3` onwards, which some distributions treat as non-free.'

A watch note about a still-maintained upstream whose activity is slowing or whose status is ambiguous, as a MyST markdown block.

Unlike unmaintained, this is purely informational: the manager stays in the default selection and in the test matrices. It renders as a {note} admonition atop the manager’s documentation page, flagging upstreams worth keeping an eye on (a slow release cadence, superseded-but-still-shipped tools, a discontinued platform still under vendor support). May embed markdown links. Mutually exclusive with unmaintained: a confirmed-dead manager carries an unmaintained_message instead. Enforced by test_maintenance_note.

name: str = 'Vagrant'

Return package manager’s common name.

Default value is based on class name.

homepage_url: str | None = 'https://www.vagrantup.com'

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

logo: str | None = 'vagrant'

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='windows', name='Windows'), 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.4.0'

The release whose listing groups boxes and renders the architecture as a trailing parenthesized segment, which is the shape _INSTALLED_REGEXP parses.

extra_env: ClassVar = {'VAGRANT_CHECKPOINT_DISABLE': '1'}

Additional environment variables to add to the current context.

Automatically applied on each meta_package_manager.execution.CLIExecutor.run_cli() calls.

version_regexes: tuple[str, ...] = ('^Vagrant[ \\t]+(?P<version>\\S+)$',)

Search the version right after the Vagrant string.

$ vagrant --version
Vagrant 2.4.9

Note the dashes: vagrant version without them is a different command that queries the network for the latest release.

property installed: Iterator[Package]

Fetch installed packages.

$ vagrant box list
linuxmint-21.3-cinnamon-64bit (hyperv, 0)
mintv1                        (hyperv, 0)
wolvverine/LinuxMintCinnamon  (hyperv, 1.1, (amd64))

property outdated: Iterator[Package]

Fetch outdated packages.

--global is what makes this answer for the machine: without it Vagrant reports only the boxes the working directory’s Vagrantfile declares, and fails where there is none.

Caution

Vagrant exits zero whether or not updates were found, by an explicit upstream decision, so the listing itself is the only signal.

$ vagrant box outdated --global
* 'ubuntu/jammy64' for 'virtualbox' is outdated! Current: 20231012.0.0. Latest: 20240126.0.0
* 'ubuntu/jammy64' for 'virtualbox' is outdated! Current: 20230914.0.0. Latest: 20240126.0.0
* 'ubuntu/jammy64' for 'virtualbox' is outdated! Current: 20230616.0.0. Latest: 20240126.0.0

search(query, extended, exact)

Fetch matching packages.

Boxes have no search of their own: the query goes to the registry through Vagrant’s cloud command tree, which answers anonymously unless credentials are explicitly requested.

Caution

Search does not support extended or exact matching.

$ vagrant cloud search ubuntu --json
[
  {
    "name": "ubuntu/jammy64",
    "version": "20240126.0.0",
    "downloads": "1,234,567",
    "providers": "virtualbox",
    "architectures": "amd64"
  }
]

Return type:

Iterator[Package]

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

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 = 'vagrant'

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.

install(package_id, version=None)

Install one package.

$ vagrant box add ubuntu/jammy64

Return type:

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)

Generates the CLI to upgrade the package provided as parameter.

--box names the box explicitly, which is what lets this run outside a Vagrant project: the bare form updates whatever the current directory’s Vagrantfile declares instead.

$ vagrant box update --box ubuntu/jammy64

Return type:

tuple[str, ...]

remove(package_id)

Removes a package.

--all removes every version, provider and architecture of the box in one call. It is what keeps this addressable by a bare name: without it Vagrant refuses a box held in several versions and demands an explicit --box-version. --force skips the confirmation Vagrant would otherwise ask for a box still attached to a machine.

$ vagrant box remove --force --all ubuntu/jammy64

Return type:

str

cleanup_orphan()

Removes outdated versions of installed boxes.

Keeps the newest version of each box and drops the rest. --force skips the confirmation Vagrant asks when a stale version is still attached to a machine, which would otherwise abort for want of a terminal.

$ vagrant box prune --force

Return type:

None