Warning

All these helper functions are mostly, if not all, related to outside-installation-instructions. Meaning the calls will affect your current running system - and not touch your installed system.

Profile related helpers

archinstall.list_profiles(filter_irrelevant_macs=True, subpath='', filter_top_level_profiles=False)

Packages

archinstall.find_package(name)

Finds a specific package via the package database. It makes a simple web-request, which might be a bit slow.

Be .. autofunction:: archinstall.find_packages

Locale related

archinstall.list_keyboard_languages()

archinstall.search_keyboard_layout(layout)

archinstall.set_keyboard_language(locale)

Services

archinstall.service_state(service_name: str)

Mirrors

archinstall.filter_mirrors_by_region(regions, destination='/etc/pacman.d/mirrorlist', *args, **kwargs)

This function will change the active mirrors on the live medium by filtering which regions are active based on regions.

Parameters:regions (str) – A series of country codes separated by ,. For instance SE,US for sweden and United States.

archinstall.add_custom_mirrors(mirrors: list, *args, **kwargs)

This will append custom mirror definitions in pacman.conf

Parameters:mirrors (dict) – A list of mirror data according to: {‘url’: ‘http://url.com’, ‘signcheck’: ‘Optional’, ‘signoptions’: ‘TrustAll’, ‘name’: ‘testmirror’}

archinstall.insert_mirrors(mirrors, *args, **kwargs)

This function will insert a given mirror-list at the top of /etc/pacman.d/mirrorlist. It will not flush any other mirrors, just insert new ones.

Parameters:mirrors (dict) – A dictionary of {‘url’ : ‘country’, ‘url2’ : ‘country’}

archinstall.use_mirrors(regions: dict, destination='/etc/pacman.d/mirrorlist')

archinstall.re_rank_mirrors(top=10, *positionals, **kwargs)

archinstall.list_mirrors()

Disk related

archinstall.BlockDevice(path, info=None)

archinstall.Partition(path: str, block_device: archinstall.lib.disk.BlockDevice, part_id=None, size=-1, filesystem=None, mountpoint=None, encrypted=False, autodetect_filesystem=True)

archinstall.Filesystem(blockdevice, mode)

archinstall.device_state(name, *args, **kwargs)

archinstall.all_disks(*args, **kwargs)

Luks (Disk encryption)

archinstall.luks2(partition, mountpoint, password, key_file=None, auto_unmount=False, *args, **kwargs)

Networking

archinstall.list_interfaces(skip_loopback=True)

General

archinstall.log(*args, **kwargs)

archinstall.locate_binary(name)

Exceptions

archinstall.RequirementError()

Common base class for all exceptions

archinstall.DiskError()

Common base class for all exceptions

archinstall.ProfileError()

Common base class for all exceptions

archinstall.SysCallError(message, exit_code)

Common base class for all exceptions

archinstall.ProfileNotFound()

Common base class for all exceptions

archinstall.HardwareIncompatibilityError()

Common base class for all exceptions

archinstall.UserError()

Common base class for all exceptions

archinstall.ServiceException()

Common base class for all exceptions