meta_package_manager.managers.zim module

meta_package_manager.managers.zim.zim_source_path()

Locate the init.zsh file every invocation sources.

Zim installs itself into $ZIM_HOME, falling back to ${ZDOTDIR:-${HOME}}/.zim when the variable is unset, exactly as its own installer and zimfw.zsh do. The path is returned whether or not it exists, so the built command stays well-formed and simply fails to source, which is what makes the version probe double as Zim’s presence check.

Return type:

Path

class meta_package_manager.managers.zim.Zim

Bases: PackageManager

Zim is a configuration framework and module manager for Zsh.

Modules are declared in the user’s .zimrc, then cloned under $ZIM_HOME. Packages are identified by the module name Zim reports, which is the id mpm keys them on.

Caution

zimfw is a shell function, not a standalone binary: it is defined by sourcing $ZIM_HOME/init.zsh, and the zimfw.zsh script behind it carries no shebang. Every invocation is therefore wrapped in zsh -c. Zsh is the binary mpm executes, and Zim’s own presence is established by the version probe: a host with Zsh but no Zim fails to source and reports no version, which leaves the manager unavailable.

Caution

No install and no remove: Zim materializes exactly the module set the user’s own .zimrc declares. zimfw install fetches what that file already names and zimfw uninstall drops what it no longer names, so neither takes a module of mpm’s choosing. Installing one would mean mpm editing the user’s .zimrc, which is configuration mpm does not own. Both operations are therefore not implemented rather than faked, and mpm auto-skips them.

Note

No outdated: zimfw check does compare each module against its remote, but it reports through the same progress display as update rather than a parseable list, and no upstream sample pins its format down. upgrade –all still works and mpm auto-skips the operation.

Documentation: zimfw.

Initialize cli_errors list.

name: str = 'Zsh Zim'

Return package manager’s common name.

Default value is based on class name.

homepage_url: str | None = 'https://zimfw.sh'

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

Zim versions independently of Zsh, so no Zsh floor applies here.

The 1.x series is where zimfw became the single entry point carrying the list, update and version subcommands this class drives.

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

Zsh is the binary mpm actually executes.

Zim is a shell function defined by an init.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'}

NO_COLOR drops the bold Zim wraps every module name in, so the listing parses as clean text. SHELL_SESSIONS_DISABLE keeps macOS’ Zsh session bookkeeping from writing a session file on every query, as for Antidote.

id: str = 'zim'

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, ...] = ('(?P<version>\\d+(?:\\.\\d+)+)',)

Zim prints its version bare, with no name or prefix around it.

Its version|--version case is a single print -R $:_zversion:`, so the regex is anchored on the shape of the version itself. The labeled `zimfw version:  ... string belongs to the separate zimfw info subcommand and is never what the probe reads.

$ zsh -c 'source ~/.zim/init.zsh && zimfw --version'
1.18.0

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 Zim needs.

The version probe is guarded by a readability test that exits successfully when init.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. An init.zsh that is present but broken still fails loudly.

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 Zim never requires elevated privileges.

Return type:

tuple[str, ...]

property installed: Iterator[Package]

Fetch installed packages.

Zim prints one module per line, suffixing each with the state flags that apply to it. Two of those flags mean the row is not an installed module and are skipped: (not installed) for a module the .zimrc declares but that was never fetched, and (unused) for a leftover directory no longer declared. (external), (frozen) and (disabled) all still describe installed modules and are kept.

$ zsh -c 'source ~/.zim/init.zsh && zimfw list'
environment
git
input
termtitle
utility
duration-info (frozen)
zsh-completions

upgrade_all_cli()

Generates the CLI to upgrade all packages.

zimfw update re-reads the module set the user’s .zimrc declares and pulls each one.

$ zimfw update

Return type:

tuple[str, ...]