archinstall Documentation

archinstall is library which can be used to install Arch Linux.

The library comes packaged with different pre-configured installers, such as the default Guided installation installer.

A demo of the Guided installation installer can be seen here: https://www.youtube.com/watch?v=9Xt7X_Iqg6E.

Some of the features of Archinstall are:

• No external dependencies or installation requirements. Runs without any external requirements or installation processes.

• Context friendly. The library always executes calls in sequential order to ensure installation-steps don’t overlap or execute in the wrong order. It also supports (and uses) context wrappers to ensure cleanup and final tasks such as mkinitcpio are called when needed.

• Full transparancy Logs and insights can be found at /var/log/archinstall both in the live ISO and the installed system.

• Accessibility friendly Archinstall works with espeakup and other accessibility tools thanks to the use of a TUI.

Running the installer

• Guided installation
  • Running the guided installation
  • Installing directly from a configuration file
  • Options for --config
  • Options for --creds
  • Options for --disk_layouts

Getting help

• Discord
• Issue tracker & bugs
  • Log files

Archinstall as a library

• Python library
  • Installing with pacman
  • Installing with PyPi
  • Install using source code
• Python module
  • Pre-requisites
  • Creating a script
  • Calling a module

Archinstall as a binary

• Binary executable
  • Using pacman
  • Using PKGBUILD
  • Manual compilation
• Binary executable
  • Executing the binary

API Reference

• archinstall.Installer
• archinstall.Profile
• archinstall.Application

API Helper functions

• Profile related helpers
• Packages
• Locale related
• Services
• Mirrors
• Disk related
• Luks (Disk encryption)
• Networking
• General
• Exceptions