Installing pmbootstrap

From postmarketOS
Revision as of 19:21, 1 February 2021 by Ityt (talk | contribs) (→‎Tab completion: Arch linux installation of argcomplete)
Jump to navigation Jump to search
Running postmarketOS, Alpine or Void Linux? Grab pmbootstrap straight from your distribution's package manager (e.g. apk add pmbootstrap)!


  • python >=3.6
  • openssl or alternative(like libressl)
  • Depending on the installation method:
    • pip3 (possibly shipped with Python)
    • git

Alpine Linux users also need to install coreutils and procps:

$ apk add python3 coreutils procps


pmbootstrap will automatically clone the pmaports.git repository during pmbootstrap init to the work dir of your choice, and afterwards you can look up the full path with pmbootstrap config aports. See git workflow for more information.

Installing automatically

Latest release with pip

pmbootstrap is up on pypi now, so it can be installed with:

$ pip3 install --user pmbootstrap

You may need to reload your configuration by running source ~/.profile.

That's it. The steps below are for alternative methods of installing pmbootstrap. Read on at #Tab completion if you are interested.


Updating to the latest version of pmbootstrap can be done like this:

$ pip3 install --user --upgrade pmbootstrap

Latest development version from git

Download pmbootstrap

$ git clone


$ cd pmbootstrap && python3 install

Installing manually

This setup is useful for hacking on pmbootstrap code, because you are directly running the code from your git tree. No need to run after each change.

Download pmbootstrap

$ git clone

Create a link

If the directory ~/.local/bin does not already exist, create it with:

$ mkdir -p ~/.local/bin

Create a symbolic link in ~/.local/bin named pmbootstrap:

$ ln -s "$PWD/pmbootstrap/" ~/.local/bin/pmbootstrap

Test installation

To test that pmbootstrap is installed correctly, open a new terminal and run:

$ pmbootstrap --version

If this returns something like pmbootstrap: command not found instead of a version number, ensure that the following lines are in ~/.profile (zsh: ~/.zprofile):

# set PATH so it includes user's private bin if it exists
if [ -d "$HOME/.local/bin" ] ; then

Then open a new terminal and try again.

Tab completion

Tab completion is an optional feature that saves you time by automatically filling in the rest of a command when you press the tab key. You can also see a list of possible commands by double pressing the tab key.

Install argcomplete with:

$ pip3 install --user argcomplete

Alternatively you can use your distro package manager to install argcomplete, for example in Ubuntu:

$ sudo apt install python-argcomplete

in Gentoo:

$ sudo emerge dev-python/argcomplete

in Arch Linux:

$ sudo pacman -S python-argcomplete

Next, do one of the following depending on the shell you use.


Add the following line to ~/.bashrc:

eval "$(register-python-argcomplete pmbootstrap)"

Then reload your configuration by opening a new terminal or by running source ~/.bashrc.


Add the following lines to ~/.zshrc:

autoload bashcompinit
eval "$(register-python-argcomplete pmbootstrap)"

Then reload your configuration by opening a new terminal or by running source ~/.zshrc.

Troubleshooting during installation

ERROR: We have split the aports repository from the pmbootstrap repository (#383). Please run 'pmbootstrap init' again to clone it

According to this reddit post you need to :

 - Delete ~/.config/pmbootstrap.cfg  => command rm 
 - Delete ~/.local/var/pmbootstrap
 - Run the pmbootstrap init again

In command line :

 rm  ~/.config/pmbootstrap.cfg
 rm -r ~/.local/var/pmbootstrap
 pmbootstrap init

See also

  • !1656 implement bash tab completion