from pydantic import InstanceOf
from abxpkg import BinProvider, Binary, BinProviderName, BinName, HandlerDict, BrewProvider
from abxpkg import env, pip, apt

class CustomBrewProvider(BrewProvider):
    name: BinProviderName = 'custom_brew'

    def get_macos_packages(self, bin_name: str, **context) -> list[str]:
        return ['yt-dlp'] if bin_name == 'ytdlp' else [bin_name]

class YtdlpBinary(Binary):
    name: BinName = 'ytdlp'
    description: str = 'YT-DLP (Replacement for YouTube-DL) Media Downloader'

    # define the providers this binary supports
    binproviders: list[InstanceOf[BinProvider]] = [env, pip, apt, CustomBrewProvider()]

    # customize installed package names for specific package managers
    overrides: dict[BinProviderName, HandlerDict] = {
        'pip': {'install_args': ['yt-dlp[default,curl-cffi]']},   # literal values
        'apt': {'install_args': lambda: ['yt-dlp', 'ffmpeg']},    # any pure Callable
        'custom_brew': {'install_args': 'self.get_macos_packages'},  # or a string ref to a method on self
    }


ytdlp = YtdlpBinary()
assert [provider.name for provider in ytdlp.binproviders] == ['env', 'pip', 'apt', 'custom_brew']
assert ytdlp.overrides['pip']['install_args'] == ['yt-dlp[default,curl-cffi]']

from abxpkg import Binary, env

# Use providers directly for host binary discovery
python = env.load('python3')
assert python and python.is_valid
print(env.PATH, env.get_abspaths('python3'), env.get_version('python3'))

# our Binary API provides a nice type-checkable, validated, serializable handle
python = Binary(name='python3', binproviders=[env]).load()
print(python)                       # Binary(name='python3', abspath=Path(...), version=SemVer(...), sha256='...', mtime=1712890123456789000)
print(python.abspaths)              # show all matching binaries found via each provider PATH
print(python.model_dump(mode='json'))  # JSON-ready dict
print(python.model_json_schema())   # ... OpenAPI-ready JSON schema showing all available fields

from pydantic import InstanceOf
from abxpkg import Binary, BinProvider, BrewProvider, EnvProvider

# You can also instantiate provider classes manually for custom configuration,
# or define binaries as classes for type checking
class CurlBinary(Binary):
    name: str = 'curl'
    binproviders: list[InstanceOf[BinProvider]] = [EnvProvider(), BrewProvider()]

curl = CurlBinary().install()
assert isinstance(curl, CurlBinary)                                 # CurlBinary is a unique type you can use in annotations now
print(curl.abspath, curl.version, curl.binprovider, curl.is_valid)  # Path(...) SemVer(...) BrewProvider()/EnvProvider() True
curl.exec(cmd=['--version'])                                        # curl 8.4.0 (x86_64-apple-darwin23.0) libcurl/8.4.0 ...

import platform
import shutil
from pydantic import InstanceOf
from abxpkg import BinProvider, Binary, BinProviderName, BinName, HandlerDict
from abxpkg import env, apt

class DockerBinary(Binary):
    name: BinName = 'docker'
    binproviders: list[InstanceOf[BinProvider]] = [env, apt]

    overrides: dict[BinProviderName, HandlerDict] = {
        'env': {
            # prefer podman if installed, fall back to docker
            'abspath': lambda: shutil.which('podman') or shutil.which('docker') or shutil.which('docker-ce'),
        },
        'apt': {
            # vary the installed package name based on CPU architecture
            'install_args': {
                'x86_64': ['docker.io'],
                'armv7l': ['docker.io'],
                'aarch64': ['docker.io'],
            }.get(platform.machine(), ['docker.io']),
        },
    }

docker = DockerBinary().install()

from pathlib import Path
from abxpkg import (
    BinProvider,
    BinProviderName,
    BinName,
    HostBinPath,
    InstallArgs,
    SemVer,
    bin_abspath,
)

class CargoProvider(BinProvider):
    name: BinProviderName = 'cargo'
    INSTALLER_BIN: BinName = 'cargo'
    PATH: str = str(Path.home() / '.cargo/bin')

    def default_install_args_handler(self, bin_name: BinName, **context) -> InstallArgs:
        return [bin_name]

    def default_install_handler(
        self,
        bin_name: BinName,
        install_args: InstallArgs | None = None,
        postinstall_scripts: bool | None = None,
        min_release_age: float | None = None,
        min_version: SemVer | None = None,
        timeout: int | None = None,
    ) -> str:
        install_args = install_args or self.get_install_args(bin_name)
        installer = self.INSTALLER_BINARY()
        assert installer and installer.loaded_abspath
        proc = self.exec(bin_name=installer.loaded_abspath, cmd=['install', *install_args], timeout=timeout)
        if proc.returncode != 0:
            self._raise_proc_error('install', install_args, proc)
        return proc.stdout.strip() or proc.stderr.strip()

    def default_abspath_handler(self, bin_name: BinName, **context) -> HostBinPath | None:
        return bin_abspath(bin_name, PATH=self.PATH)

    def default_version_handler(
        self,
        bin_name: BinName,
        abspath: HostBinPath | None = None,
        timeout: int | None = None,
        **context,
    ) -> SemVer | None:
        return self._version_from_exec(bin_name, abspath=abspath, timeout=timeout)


cargo = CargoProvider()
assert cargo.get_install_args('ripgrep') == ('ripgrep',)
assert cargo.default_install_args_handler('ripgrep') == ['ripgrep']

abxpkg uses the standard Python logging module. By default it stays quiet unless your application configures logging explicitly.

import logging
from abxpkg import Binary, env, configure_logging

configure_logging(logging.INFO)

python = Binary(name='python', binproviders=[env]).load()

To enable Rich logging:

pip install "abxpkg[rich]"

import logging
from abxpkg import Binary, EnvProvider, configure_rich_logging

configure_rich_logging(logging.DEBUG)

python = Binary(name='python', binproviders=[EnvProvider()]).load()

Debug logging is hardened so logging itself does not become the failure. If a provider/model object has a broken or overly-expensive repr(), abxpkg falls back to a short ClassName(...) summary instead of raising while formatting log output.

configure_rich_logging(...) uses rich.logging.RichHandler under the hood, so log levels, paths, arguments, and command lines render with terminal colors when supported.

You can also manage it with standard logging primitives:

import logging

logging.basicConfig(level=logging.INFO)
logging.getLogger("abxpkg").setLevel(logging.DEBUG)

With a few more packages, you get type-checked Django fields & forms that support BinProvider and Binary.

[!TIP] For the full Django experience, we recommend installing these 3 excellent packages:

• django-admin-data-views
• django-pydantic-field
• django-jsonform pip install abxpkg django-admin-data-views django-pydantic-field django-jsonform

Django model fields:

from django.conf import settings

if not settings.configured:
    settings.configure(
        INSTALLED_APPS=[
            'django.contrib.admin',
            'django.contrib.auth',
            'django.contrib.contenttypes',
        ],
        DATABASES={'default': {'ENGINE': 'django.db.backends.sqlite3', 'NAME': ':memory:'}},
        SECRET_KEY='abxpkg-docs',
    )

import django
django.setup()

from django.db import models
from django.db import connection
from abxpkg import Binary, EnvProvider, SemVer
from django_pydantic_field import SchemaField

provider_runtime_fields = {name: True for name in EnvProvider.model_computed_fields}
binary_runtime_fields = {name: True for name in Binary.model_computed_fields}
binary_runtime_fields['binproviders'] = True
binary_runtime_fields['loaded_binprovider'] = True

class Dependency(models.Model):
    label = models.CharField(max_length=63)
    default_binprovider: EnvProvider = SchemaField(exclude=provider_runtime_fields)
    binaries: list[Binary] = SchemaField(
        default=[],
        exclude={'__all__': binary_runtime_fields},
    )
    min_version: SemVer = SchemaField(default=(0, 0, 1))

    class Meta:
        app_label = 'abxpkg_docs'

with connection.schema_editor() as schema_editor:
    schema_editor.create_model(Dependency)

Saving a Binary using the model:

from abxpkg import Binary, env

python = Binary(name='python3', binproviders=[env]).load()

obj = Dependency(
    label='runtime tools',
    default_binprovider=env,   # store BinProvider values directly
    binaries=[python],          # store Binary/SemVer values directly
)
obj.save()

When fetching back from the DB, Binary fields are auto-deserialized and immediately usable:

obj = Dependency.objects.get(label='runtime tools')
assert obj.binaries[0].abspath == python.abspath
obj.binaries[0].exec(cmd=['--version'])

For a full example see the bundled django_example_project/.

Django Admin integration:

# settings.py
INSTALLED_APPS = [
    # ...
    'admin_data_views',
    'abxpkg',
]

ABXPKG_GET_ALL_BINARIES = 'project.views.get_all_binaries'
ABXPKG_GET_BINARY = 'project.views.get_binary'

ADMIN_DATA_VIEWS = {
    "NAME": "Environment",
    "URLS": [
        {
            "route": "binaries/",
            "view": "abxpkg.views.binaries_list_view",
            "name": "binaries",
            "items": {
                "route": "<str:key>/",
                "view": "abxpkg.views.binary_detail_view",
                "name": "binary",
            },
        },
    ],
}

If you override the default site admin, register the views manually:

from django.conf import settings
if not settings.configured:
    settings.configure(INSTALLED_APPS=[])

import django
django.setup()
from django.contrib.admin import AdminSite
from abxpkg.admin import register_admin_views

custom_admin = AdminSite(name='custom')
register_admin_views(custom_admin)

Source: abxpkg/binprovider.py • Tests: tests/test_envprovider.py

from abxpkg.binprovider import DEFAULT_ENV_PATH

INSTALLER_BIN = "which"
PATH = DEFAULT_ENV_PATH              # current PATH + current Python bin dir

• Install root: defaults to ABXPKG_ENV_ROOT, or ABXPKG_LIB_DIR/env, or the platform default abx lib dir under env/. env is still read-only: it only resolves binaries that already exist on the host PATH, but when an install root is configured it also keeps a managed bin/ symlink dir and derived.env cache there.
• Auto-switching: none.
• Security: min_release_age and postinstall_scripts are unsupported here and are ignored with a warning if explicitly passed to install() / update().
• Overrides: abspath / version are the useful ones here. python has a built-in override to the current sys.executable and interpreter version.
• Notes: with a managed env root, compatible host binaries are projected into env/bin/<name> and resolved through that stable symlink. install() / update() return explanatory no-op messages, and uninstall() is a no-op.

Source: abxpkg/binprovider_apt.py • Tests: tests/test_aptprovider.py

INSTALLER_BIN = "apt-get"
PATH = ""                            # populated from `dpkg -L bash` bin/sbin roots
euid = 0                             # always runs as root

• Install root: no hermetic prefix support. Installs into the host package database.
• Auto-switching: none. Shells out to apt-get directly.
• dry_run: shared behavior.
• Security: min_release_age and postinstall_scripts=False are unsupported and are ignored with a warning if explicitly requested.
• Overrides: install_args becomes apt-get install -y -qq --no-install-recommends ...; update() uses apt-get install --only-upgrade ...; uninstall() uses apt-get remove -y -qq ....
• Notes: direct mode uses the existing apt index first, refreshing stale indexes only after an install fails or a custom repository is added. It requests privilege escalation when needed. Executables without a usable version flag are versioned from their owning package's dpkg-query metadata.

Source: abxpkg/binprovider_brew.py • Tests: tests/test_brewprovider.py

INSTALLER_BIN = "brew"
PATH = "/home/linuxbrew/.linuxbrew/bin:/opt/homebrew/bin:/usr/local/bin"
brew_prefix = "/opt/homebrew"        # guessed host prefix: /opt/homebrew, /usr/local, or linuxbrew

• Install root: brew_prefix is the Homebrew prefix used for discovery and shelling out to brew. By default it resolves from ABXPKG_BREW_ROOT, or ABXPKG_LIB_DIR/brew, or a guessed host prefix (/opt/homebrew, /usr/local, or linuxbrew). bin_dir is used for linked formula binaries when abxpkg manages them separately.
• Auto-switching: none. Shells out to brew directly.
• dry_run: shared behavior.
• Security: min_release_age is unsupported and is ignored with a warning if explicitly requested. postinstall_scripts=False is supported on brew install via --skip-post-install, and ABXPKG_POSTINSTALL_SCRIPTS hydrates the provider default here. Homebrew has no equivalent flag for brew upgrade, so updates run without it.
• Overrides: install_args maps to formula / cask args passed to brew install, brew upgrade, and brew uninstall.
• Notes: direct mode runs brew update at most once per day. Explicit --skip-post-install args in install_args win over derived defaults for installs.

Source: abxpkg/binprovider_pip.py • Tests: tests/test_pipprovider.py, tests/test_security_controls.py

INSTALLER_BIN = "pip"
PATH = ""                            # auto-built from global/user Python bin dirs
install_root = None                  # None = ambient/global mode, Path(...) = provider root

• Install root: install_root=None uses the system/user Python environment. Set install_root=Path(...) for a hermetic provider root whose actual virtualenv lives at <install_root>/venv, with executables under <install_root>/venv/bin and provider metadata like derived.env kept at <install_root>.
• Auto-switching: none. Shells out to pip directly. Honors PIP_BINARY=/abs/path/to/pip. Use UvProvider for uv-backed installs.
• dry_run: shared behavior.
• Security: supports postinstall_scripts=False (always) and min_release_age (on pip >= 26.0 or in a freshly bootstrapped pip venv). Hydrated from ABXPKG_POSTINSTALL_SCRIPTS and ABXPKG_MIN_RELEASE_AGE. For stricter enforcement on hosts with older system pip, use UvProvider instead.
• Overrides: install_args is passed as pip requirement specs; unpinned specs get a >=min_version floor when min_version is supplied.
• Notes: postinstall_scripts=False adds pip --only-binary :all: (wheels only, no arbitrary sdist build scripts). min_release_age is enforced with pip --uploaded-prior-to=<ISO8601> on pip >= 26.0 (see pypa/pip#13625); older pip silently skips the flag. Explicit conflicting flags already present in install_args win over the derived defaults. get_version / get_abspath fall back to parsing pip show <package> output when the console script can't report its own version.

Source: abxpkg/binprovider_uv.py • Tests: tests/test_uvprovider.py

INSTALLER_BIN = "uv"
PATH = ""                            # prepends <install_root>/venv/bin or the uv tool bin dir
install_root = None                  # None = global uv tool mode, Path(...) = provider root

• Install root: two modes, picked by whether install_root is set.
  • Hermetic venv mode (install_root=Path(...)): treats install_root as a provider root, creates the real venv at <install_root>/venv via uv venv, and installs packages into it with uv pip install --python <install_root>/venv/bin/python .... Binaries land in <install_root>/venv/bin/<name>, while provider metadata like derived.env stays at <install_root>. This matches PipProvider's layout.
  • Global tool mode (install_root=None): delegates to uv tool install which creates a fresh venv per tool under UV_TOOL_DIR (default ~/.local/share/uv/tools) and writes shims into UV_TOOL_BIN_DIR (default ~/.local/bin). Pass bin_dir=Path(...) to override the shim dir. This is the idiomatic "install a CLI tool globally" path.
• Auto-switching: none. Honors UV_BINARY=/abs/path/to/uv. If uv isn't on the host, the provider is unavailable.
• dry_run: shared behavior.
• Security: supports both min_release_age and postinstall_scripts=False, and hydrates their provider defaults from ABXPKG_MIN_RELEASE_AGE and ABXPKG_POSTINSTALL_SCRIPTS. In both modes, postinstall_scripts=False becomes --no-build (wheels-only, no arbitrary sdist build scripts) and min_release_age becomes --exclude-newer=<ISO8601> (uv 0.4+). Explicit conflicting flags already present in install_args win over the derived defaults.
• Overrides: install_args is passed as requirement specs; unpinned specs get a >=min_version floor when min_version is supplied.
• Notes: update in venv mode is uv pip install --upgrade; update in global mode is uv tool install --force (re-installs the tool's venv). Uninstall in venv mode uses uv pip uninstall --python <venv>/bin/python; in global mode it uses uv tool uninstall <name>.

Source: abxpkg/binprovider_npm.py • Tests: tests/test_npmprovider.py, tests/test_security_controls.py

INSTALLER_BIN = "npm"
PATH = ""                            # auto-built from npm local + global bin dirs
install_root = None                  # None = global install, Path(...) = prefix/project root

• Install root: install_root=None installs globally (walks up from the host's npm prefix / npm prefix -g to seed PATH). Set install_root=Path(...) to install under <prefix>/node_modules/.bin; that prefix bin dir becomes the provider's active executable search path.
• Auto-switching: none. Shells out to npm directly and expects npm to be installed on the host. Honors NPM_BINARY=/abs/path/to/npm. Use PnpmProvider for pnpm.
• dry_run: shared behavior.
• Security: supports both postinstall_scripts=False and min_release_age, hydrated from ABXPKG_POSTINSTALL_SCRIPTS and ABXPKG_MIN_RELEASE_AGE. min_release_age requires an npm build that ships --min-release-age (detected once by probing npm install --help).
• Overrides: install_args is passed as npm package specs; unpinned specs get rewritten to pkg@>=<min_version> when min_version is supplied.
• Notes: postinstall_scripts=False adds --ignore-scripts; min_release_age adds --min-release-age=<days>; and installs always include npm's standard non-interactive flags (--force --no-audit --no-fund --loglevel=error). puppeteer is special-cased to install both puppeteer and @puppeteer/browsers, and puppeteer-browsers resolves to @puppeteer/browsers. Explicit conflicting flags already present in install_args win over the derived defaults. get_version / get_abspath fall back to parsing npm show --json <package> and npm list --json --depth=0 output when the console script can't report its own version.

Source: abxpkg/binprovider_pnpm.py • Tests: tests/test_pnpmprovider.py

INSTALLER_BIN = "pnpm"
PATH = ""                            # auto-built from pnpm local + global bin dirs
install_root = None                  # None = global install, Path(...) = prefix/project root

• Install root: install_root=None installs globally. Set install_root=Path(...) to install under <prefix>/node_modules/.bin; that prefix bin dir becomes the provider's active executable search path.
• Shells out to pnpm directly. Honors PNPM_BINARY=/abs/path/to/pnpm. Use NpmProvider for npm.
• dry_run: shared behavior.
• Security: supports both min_release_age and postinstall_scripts=False, and hydrates their provider defaults from ABXPKG_MIN_RELEASE_AGE and ABXPKG_POSTINSTALL_SCRIPTS. min_release_age requires pnpm 10.16+, and supports_min_release_age() returns False on older hosts (then it logs a warning and continues).
• Overrides: install_args is passed as pnpm package specs; unpinned specs get rewritten to pkg@>=<min_version> when min_version is supplied.
• Notes: pnpm has no --min-release-age CLI flag; this provider passes --config.minimumReleaseAge=<minutes> (the camelCase / kebab-case form pnpm exposes via its --config.<key>=<value> override). Installs always include --loglevel=error, and PNPM_HOME is auto-populated so pnpm add -g works without polluting the user's shell config. puppeteer is special-cased to install both puppeteer and @puppeteer/browsers, and puppeteer-browsers resolves to @puppeteer/browsers.

Source: abxpkg/binprovider_yarn.py • Tests: tests/test_yarnprovider.py

INSTALLER_BIN = "yarn"
PATH = ""                            # prepends <install_root>/node_modules/.bin
install_root = None                  # project dir, defaults to ABXPKG_YARN_ROOT or ABXPKG_LIB_DIR/yarn

• Install root: Yarn operates inside a project directory. Set install_root=Path(...) for an isolated project dir; that directory is auto-initialized with a stub package.json and .yarnrc.yml (nodeLinker: node-modules so binaries land in <install_root>/node_modules/.bin). When unset, the provider relies on $ABXPKG_YARN_ROOT or $ABXPKG_LIB_DIR/yarn; if neither is configured, the provider is unavailable.
• Auto-switching: none. Honors YARN_BINARY=/abs/path/to/yarn. Both Yarn classic (1.x) and Yarn Berry (2+) work for basic install/update/uninstall, but only Yarn 4.10+ supports the security flags.
• dry_run: shared behavior.
• Security: supports both min_release_age and postinstall_scripts=False, and hydrates their provider defaults from ABXPKG_MIN_RELEASE_AGE and ABXPKG_POSTINSTALL_SCRIPTS. Both controls require Yarn 4.10+; on older hosts supports_min_release_age() / supports_postinstall_disable() return False and explicit values are logged-and-ignored.
• Overrides: install_args is passed as Yarn package specs; unpinned specs get rewritten to pkg@>=<min_version> when min_version is supplied.
• Notes: Yarn has no --ignore-scripts / --minimum-release-age CLI flags; the provider writes npmMinimalAgeGate: 7d (or whatever days value is configured) and enableScripts: false into <install_root>/.yarnrc.yml and additionally passes --mode skip-build to yarn add / yarn up when postinstall_scripts=False. Updates use yarn up <pkg> (Berry) or yarn upgrade <pkg> (classic). YARN_GLOBAL_FOLDER and YARN_CACHE_FOLDER are pointed at the provider cache dir so installs share a single cache across workspaces. puppeteer is special-cased to install both puppeteer and @puppeteer/browsers, and puppeteer-browsers resolves to @puppeteer/browsers.

Source: abxpkg/binprovider_bun.py • Tests: tests/test_bunprovider.py

INSTALLER_BIN = "bun"
PATH = ""                            # prepends <install_root>/bin
install_root = None                  # mirrors $BUN_INSTALL, None = ~/.bun (host-default)

• Install root: install_root=None writes into the host $BUN_INSTALL (default ~/.bun). Set install_root=Path(...) to install under <install_root>/bin; the provider also creates <install_root>/install/global for the global node_modules dir, which is where bun puts the actual package state. The bin dir becomes the provider's active executable search path.
• Auto-switching: none. Honors BUN_BINARY=/abs/path/to/bun.
• dry_run: shared behavior.
• Security: supports both min_release_age and postinstall_scripts=False, and hydrates their provider defaults from ABXPKG_MIN_RELEASE_AGE and ABXPKG_POSTINSTALL_SCRIPTS. min_release_age requires Bun 1.3+, and supports_min_release_age() returns False on older hosts.
• Overrides: install_args is passed as Bun package specs; unpinned specs get rewritten to pkg@>=<min_version> when min_version is supplied.
• Notes: install/update use bun add -g (with --force as the update fallback). The provider passes --ignore-scripts for postinstall_scripts=False and --minimum-release-age=<seconds> (Bun's unit is seconds; this provider converts from days). puppeteer is special-cased to install both puppeteer and @puppeteer/browsers, and puppeteer-browsers resolves to @puppeteer/browsers. Explicit conflicting flags already present in install_args win over the derived defaults.

Source: abxpkg/binprovider_deno.py • Tests: tests/test_denoprovider.py

INSTALLER_BIN = "deno"
PATH = ""                            # prepends <install_root>/bin
install_root = None                  # mirrors $DENO_INSTALL_ROOT, None = ~/.deno

• Install root: install_root=None writes into the host $DENO_INSTALL_ROOT (default ~/.deno). Set install_root=Path(...) for a hermetic root with executables under <install_root>/bin; DENO_DIR is then derived as <install_root>/.cache.
• Auto-switching: none. Honors DENO_BINARY=/abs/path/to/deno.
• dry_run: shared behavior.
• Security: supports both min_release_age and postinstall_scripts=False / True, and hydrates their provider defaults from ABXPKG_MIN_RELEASE_AGE and ABXPKG_POSTINSTALL_SCRIPTS. min_release_age requires Deno 2.5+, and supports_min_release_age() returns False on older hosts.
• Overrides: install_args is passed as deno install package specs and is auto-prefixed with npm: when an unqualified bare name is supplied. Already-qualified specs (npm:, jsr:, https://...) are passed through verbatim. Unpinned specs get rewritten to pkg@>=<min_version> when min_version is supplied.
• Notes: install / update both run deno install -g --force --allow-all -n <bin_name> <pkg> because Deno's idiomatic update path is just a fresh global install. Deno's npm lifecycle scripts are opt-in (the opposite of npm), so the provider only adds --allow-scripts when postinstall_scripts=True. min_release_age is passed as --minimum-dependency-age=<minutes> (Deno's preferred unit; this provider converts from days). puppeteer is special-cased to install both puppeteer and @puppeteer/browsers, and puppeteer-browsers resolves to @puppeteer/browsers. DENO_TLS_CA_STORE=system is set so installs work on hosts with corporate / sandboxed CA bundles.

Source: abxpkg/binprovider_bash.py • Tests: tests/test_bashprovider.py

import os
from pathlib import Path

INSTALLER_BIN = "bash"
PATH = ""
lib_dir = Path(os.environ.get("ABXPKG_LIB_DIR", "~/.config/abx/lib")).expanduser()
install_root = Path(os.environ.get("ABXPKG_BASH_ROOT", lib_dir / "bash"))
bin_dir = install_root / "bin"

• Install root: set install_root for the state dir, and bin_dir for the executable output dir.
• Auto-switching: none.
• dry_run: shared behavior.
• Security: min_release_age and postinstall_scripts=False are unsupported and are ignored with a warning if explicitly requested.
• Overrides: this provider is driven by literal per-binary shell overrides for install, update, and uninstall.
• Notes: the provider exports INSTALL_ROOT, BIN_DIR, BASH_INSTALL_ROOT, and BASH_BIN_DIR into the shell environment for those commands.

Source: abxpkg/binprovider_cargo.py • Tests: tests/test_cargoprovider.py

INSTALLER_BIN = "cargo"
PATH = ""                            # prepends cargo_root/bin and cargo_home/bin
cargo_root = None                    # set this for hermetic installs

• Install root: set install_root=Path(...) or cargo_root=Path(...) for isolated installs under <cargo_root>/bin; otherwise installs go through cargo_home.
• Auto-switching: none.
• dry_run: shared behavior.
• Security: min_release_age and postinstall_scripts=False are unsupported and are ignored with a warning if explicitly requested.
• Overrides: install_args is passed to cargo install; min_version becomes cargo install --version >=....
• Notes: the provider also sets CARGO_HOME, CARGO_TARGET_DIR, and CARGO_INSTALL_ROOT when applicable.

Source: abxpkg/binprovider_gem.py • Tests: tests/test_gemprovider.py

from abxpkg.binprovider import DEFAULT_ENV_PATH

INSTALLER_BIN = "gem"
PATH = DEFAULT_ENV_PATH
install_root = None                  # defaults to $GEM_HOME or ~/.local/share/gem
bin_dir = None                       # defaults to <install_root>/bin

• Install root: set install_root, and optionally bin_dir, for hermetic installs; otherwise it uses $GEM_HOME or ~/.local/share/gem.
• Auto-switching: none.
• dry_run: shared behavior.
• Security: min_release_age and postinstall_scripts=False are unsupported and are ignored with a warning if explicitly requested.
• Overrides: install_args maps to gem install ..., gem update ..., and gem uninstall ...; min_version becomes --version >=....
• Notes: generated wrapper scripts are patched so they activate the configured GEM_HOME instead of the host default.

Source: abxpkg/binprovider_goget.py • Tests: tests/test_gogetprovider.py

from abxpkg.binprovider import DEFAULT_ENV_PATH

INSTALLER_BIN = "go"
PATH = DEFAULT_ENV_PATH
install_root = None                  # defaults to $GOPATH or ~/go
bin_dir = None                       # defaults to <install_root>/bin

• Install root: set install_root for the Go install tree, and optionally bin_dir for the executable dir; otherwise installs land in <install_root>/bin.
• Auto-switching: none. Resolves a compatible host go first, then installs Go through Apt or Homebrew if it is missing.
• dry_run: shared behavior.
• Security: min_release_age and postinstall_scripts=False are unsupported and are ignored with a warning if explicitly requested.
• Overrides: install_args is passed to go install ...; the default is ["<bin_name>@latest"].
• Notes: update() is just install() again. Version detection prefers go version -m <binary> and falls back to the generic version probe. The provider name is goget, not go_get.

Source: abxpkg/binprovider_nix.py • Tests: tests/test_nixprovider.py

import os
from pathlib import Path

INSTALLER_BIN = "nix"
PATH = ""                            # prepends <install_root>/bin
install_root = Path(os.environ.get("ABXPKG_NIX_PROFILE", "~/.nix-profile")).expanduser()

• Install root: set install_root=Path(...) for a custom profile.
• Auto-switching: none.
• dry_run: shared behavior.
• Security: min_release_age and postinstall_scripts=False are unsupported and are ignored with a warning if explicitly requested.
• Overrides: install_args is passed to nix profile install ...; the default is [bin_name]. Search results use the explicit official nixpkgs-unstable channel archive instead of the host's Nix registry.
• Notes: update/uninstall operate on the resolved profile element name rather than reusing the full flake ref.

Source: abxpkg/binprovider_docker.py • Tests: tests/test_dockerprovider.py

import os
from pathlib import Path

INSTALLER_BIN = "docker"
PATH = ""                            # prepends bin_dir
lib_dir = Path(os.environ.get("ABXPKG_LIB_DIR", "~/.config/abx/lib")).expanduser()
docker_root = Path(os.environ.get("ABXPKG_DOCKER_ROOT", lib_dir / "docker"))
bin_dir = docker_root / "bin"

• Install root: partial only. Images are pulled into Docker's host image store; the provider only controls the local shim dir and metadata dir. Use install_root=Path(...) for the shim/metadata root or bin_dir=Path(...) for the shim dir directly.
• Auto-switching: none.
• dry_run: shared behavior.
• Security: min_release_age and postinstall_scripts=False are unsupported and are ignored with a warning if explicitly requested.
• Overrides: install_args is a list of Docker image refs. The first item is treated as the main image and becomes the generated shim target.
• Notes: default install args are ["<bin_name>:latest"]. install() / update() run docker pull, write metadata JSON, and create an executable wrapper that runs docker run .... Expects image refs as install args, typically via overrides on a Binary. It writes a local wrapper script for the binary and executes it via docker run ...; the binary version is parsed from the image tag, so semver-like tags work best.

Source: abxpkg/binprovider_chromewebstore.py • Tests: tests/test_chromewebstoreprovider.py

import os
from pathlib import Path

INSTALLER_BIN = "node"
PATH = ""
lib_dir = Path(os.environ.get("ABXPKG_LIB_DIR", "~/.config/abx/lib")).expanduser()
install_root = Path(os.environ.get("ABXPKG_CHROMEWEBSTORE_ROOT", lib_dir / "chromewebstore"))
bin_dir = install_root / "extensions"

• Install root: set install_root for the extension cache root, and bin_dir for the unpacked extension output dir.
• Auto-switching: none.
• dry_run: shared behavior.
• Security: min_release_age is unsupported and is ignored with a warning if explicitly requested. postinstall_scripts=False is supported as a standard kwarg and ABXPKG_POSTINSTALL_SCRIPTS hydrates the provider default here, but there is no extra install-time toggle beyond the packaged JS helper this provider already uses.
• Overrides: install_args are [webstore_id, "--name=<extension_name>"].
• Notes: the packaged chromewebstore_utils.js helper is used to download, unpack, and cache the extension, and the resolved binary path is the unpacked manifest.json. no_cache=True bypasses that metadata cache on the next install/update without deleting the unpacked extension tree.

Source: abxpkg/binprovider_puppeteer.py • Tests: tests/test_puppeteerprovider.py

import os
from pathlib import Path

INSTALLER_BIN = "puppeteer-browsers"
PATH = ""
lib_dir = Path(os.environ.get("ABXPKG_LIB_DIR", "~/.config/abx/lib")).expanduser()
install_root = Path(os.environ.get("ABXPKG_PUPPETEER_ROOT", lib_dir / "puppeteer"))
bin_dir = install_root / "bin"

• Install root: set install_root for the root dir and bin_dir for symlinked executables. Leave it unset for ambient/global mode, where cache ownership stays with the host. INSTALLER_BINARY() intentionally resolves only an already-bootstrapped puppeteer-browsers CLI from the shared ABXPKG_LIB_DIR/npm bin dir, a custom provider-local npm prefix, or ambient PATH; it does not delegate to the generic cross-provider installer resolver.
• Browser cache: when install_root is pinned, abxpkg manages <install_root>/cache end-to-end — it's exported as PUPPETEER_CACHE_DIR to every subprocess, used for --path= on puppeteer-browsers install / list, and uninstall() resolves the real browser directory via load() then rmtrees it. When install_root is unset the provider is in pure passthrough mode: the caller's ambient $PUPPETEER_CACHE_DIR (or the CLI's ~/.cache/puppeteer default) flows through to subprocesses unchanged, load() trusts whatever path puppeteer-browsers list reports, and uninstall() still rmtrees the real browser directory returned by load() — leaving any unrelated browsers in the shared cache alone.
• Auto-switching: setup bootstraps @puppeteer/browsers through NpmProvider and then uses that CLI for browser installs.
• dry_run: shared behavior.
• Security: min_release_age is unsupported for browser installs and is ignored with a warning if explicitly requested. postinstall_scripts=False is supported for the underlying npm bootstrap path, and ABXPKG_POSTINSTALL_SCRIPTS hydrates the provider default here.
• Overrides: install_args are passed through to @puppeteer/browsers install ..., with the provider appending --path=<cache_dir>. Installing puppeteer-browsers itself is treated as the CLI bootstrap case, not as a browser target.
• Notes: installed-browser resolution uses semantic version ordering, not lexicographic string sorting. The provider records node and puppeteer-browsers as dependency cache entries when they are resolved through upstream providers.

Source: abxpkg/binprovider_playwright.py • Tests: tests/test_playwrightprovider.py

from pathlib import Path

INSTALLER_BIN = "playwright"
PATH = ""
install_root = None              # abxpkg-managed root dir for bin_dir / nested npm prefix
bin_dir = Path("/tmp/abxpkg-playwright/bin")  # symlink dir when install_root is configured
euid = 0                         # routes exec() through sudo-first-then-fallback

• Install root: set install_root to pin the abxpkg-managed root dir (where bin_dir symlinks and the nested npm prefix live). Leave it unset to let playwright use its own OS-default browsers path (~/.cache/ms-playwright on Linux etc.) — in that case abxpkg maintains no symlink dir or npm prefix at all, the playwright npm CLI bootstraps against the host's npm default, and load() returns the resolved executablePath() directly. bin_dir overrides the symlink directory when install_root is pinned. INSTALLER_BINARY() intentionally resolves only an already-bootstrapped playwright CLI from the shared ABXPKG_LIB_DIR/npm bin dir, a custom provider-local npm prefix, or ambient PATH; it does not delegate to the generic cross-provider installer resolver.
• Browser cache: when install_root is pinned, abxpkg manages <install_root>/cache end-to-end — exported as PLAYWRIGHT_BROWSERS_PATH to every subprocess (including the env KEY=VAL -- ... wrapper used when we go through sudo), used to scope executablePath() hits on load(), and uninstall() resolves the real browser directory via load() then rmtrees it. When install_root is unset the provider is in pure passthrough mode: the caller's ambient $PLAYWRIGHT_BROWSERS_PATH (or playwright's ~/.cache/ms-playwright default on Linux) flows through to subprocesses unchanged, load() trusts whatever path executablePath() reports, and uninstall() still rmtrees the real browser directory returned by load().
• Auto-switching: setup bootstraps the playwright npm package through NpmProvider, then runs playwright install --with-deps <install_args> against it. Resolves each installed browser's real executable via the playwright-core Node.js API (chromium.executablePath() etc.) and writes a symlink into bin_dir when one is configured.
• dry_run: shared behavior — the install handler short-circuits to a placeholder without touching the host.
• Privilege handling: --with-deps installs system packages and requires root on Linux. euid defaults to 0, which routes every exec() call through the base BinProvider.exec sudo-first-then-fallback path — it tries sudo -n -- playwright install --with-deps ... first on non-root hosts, falls back to running the command directly if sudo fails or isn't available, and merges both stderr outputs into the final error if both attempts fail.
• Security: min_release_age and postinstall_scripts=False are unsupported for browser installs and are ignored with a warning if explicitly requested.
• Overrides: install_args are appended onto playwright install after playwright_install_args (defaults to ["--with-deps"]) and passed through verbatim — use whatever browser names / flags the playwright install CLI accepts (chromium, firefox, webkit, --no-shell, --only-shell, --force, etc.).
• Notes: update() bumps the playwright npm package in install_root first (via NpmProvider.update) so its pinned browser versions refresh, then re-runs playwright install --force <install_args> to pull any new browser builds. uninstall() resolves the browser's real install directory via playwright-core's executablePath(), walks up to the containing <bin_name>-<buildId>/ dir, and rmtrees that dir — in both managed and passthrough modes — because playwright uninstall itself has no per-browser argument and only drops unused browsers wholesale.

Source: abxpkg/binprovider_pyinfra.py • Tests: tests/test_pyinfraprovider.py

import os
from abxpkg.binprovider import DEFAULT_PATH

INSTALLER_BIN = "pyinfra"
PATH = os.environ.get("PATH", DEFAULT_PATH)
pyinfra_installer_module = "auto"
pyinfra_installer_kwargs = {}

• Install root: no hermetic prefix support. It delegates to host package managers through pyinfra operations.
• Auto-switching: installer_module="auto" resolves to operations.brew.packages on macOS and operations.server.packages on Linux.
• dry_run: shared behavior.
• Security: min_release_age and postinstall_scripts=False are unsupported and are ignored with a warning if explicitly requested.
• Overrides: install_args is the package list passed to the selected pyinfra operation.
• Notes: privilege requirements depend on the underlying package manager and selected module. When pyinfra tries a privileged sudo path and then falls back, both error outputs are preserved if the final attempt also fails.

Source: abxpkg/binprovider_ansible.py • Tests: tests/test_ansibleprovider.py

import os
from abxpkg.binprovider import DEFAULT_PATH
from abxpkg.binprovider_ansible import ANSIBLE_INSTALL_PLAYBOOK_TEMPLATE

INSTALLER_BIN = "ansible"
PATH = os.environ.get("PATH", DEFAULT_PATH)
ansible_installer_module = "auto"
ansible_playbook_template = ANSIBLE_INSTALL_PLAYBOOK_TEMPLATE

• Install root: no hermetic prefix support. It delegates to the host via ansible-runner.
• Auto-switching: installer_module="auto" resolves to community.general.homebrew on macOS and ansible.builtin.package on Linux.
• dry_run: shared behavior.
• Security: min_release_age and postinstall_scripts=False are unsupported and are ignored with a warning if explicitly requested.
• Overrides: install_args becomes the playbook loop input for the chosen Ansible module.
• Notes: when using the Homebrew module, the provider auto-injects the detected brew search path into module kwargs. Privilege requirements still come from the underlying package manager, and failed sudo attempts are included in the final error if the fallback attempt also fails.