AUR helper with minimal dependencies. Review PKGBUILDs all in once, next build them all without user interaction.
Inspired bypacaur,yaourtandyay.
Instead of trying to be smarter than pacman (by using--nodeps,--force,--ask,--noconfirmand so) it just interactively tells pacman what to do. If pacman asks some unexpected question, the user will be just able to answer it manually.
Notable features:
- build local PKGBUILDs with AUR deps (
-P/--pkgbuild) - retrieve PKGBUILDs from AUR and ABS (
-G/--getpkgbuild) - interactively handle common build problems (like untrusted GPG key or checksum mismatch, wrong architecture)
- usingsystemd dynamic usersif building packages as root user
- show unreadArch newsbefore sysupgrade
- [m]anual package selection ininstall promptusing text editor (ignore unwanted updates or select package provider)
- show AUR package diff and review PKGBUILD and.install files
- upgrade
-git,-svnand other dev packages - AUR package names in shell completion (bash, fish, zsh)
- quickly search&install package by
pikaur <search-query>
The following pacman operations are extended with AUR capabilities:
-S(build AUR packages,--needed,--ignoreand--noconfirmare supported as in pacman, other args are just bypassed to it)-Sw(build AUR packages but don't install)-Ss(search or list all AUR packages,-qalso supported)-Si(package info)-Su/-Syu(sysupgrade)-Sc/-Scc(build dir/built packages cache clean)-Qu(query upgradeable,-qsupported)
Also seepikaur -Sh,-Qh,-Ph,-Ghand-Xhfor pikaur-specific flags.
Pikaur wraps all the pacman options accurately except for-Syuwhich is being split into-Sy(to refresh package list first) and-Su(to install upgrades after user confirmed the package list or altered it via [M]anual package selection).
sudo pacman -S --needed base-devel git
git clone https://aur.archlinux.org/pikaur.git
cdpikaur
makepkg -fsri
To avoid situations during upgrading the system when you can't run Pikaur anymore (for example due breaking changes in Python, Pyalpm or other system dep) it's recommended to havepikaur-static ⚡️installed, which doesn't depend on Python (or Pyalpm) and doesn't conflict with the regular pikaur installation.
You can download it from theReleases Page
(or downgrade Python/[other pkg which broke the update] to the previous version if it broke due to update, build+installpikaur-staticfrom aur, upgrade python/[that pkg] again).
git clone https://github.com/actionless/pikaur.git
cdpikaur
python3./pikaur.py -S AUR_PACKAGE_NAME~/.cache/pikaur/
├── build/#build directory (removed after successful build)
├── pkg/#built packages directory
~/.config/pikaur.conf#config file
~/.local/share/pikaur/
└── aur_repos/#keep aur repos there; show diff when updating
└── last_installed.txt#aur repo hash of last successfully installed package~/.config/pikaur.conf
When doing sysupgrade, count all devel (-git, -svn, -bzr, -hg, -cvs) packages older than N days as being upgradeable.
-1 disables this.
0 means always upgrade.
Passing--develargument will override this option to 0.
When installing new packages, show their repository name, even if they are coming from one of the official Arch Linux repositories.
When upgrading packages, sort them byversiondiff,pkgnameorrepo.
When installing repository packages, show their download size.
When doing sysupgrade ignore AUR packages which haveoutofdatemark.
Provides an override path for the GPG home directory used when validating aur package sources.
See explanations of--homedirand${GNUPGHOME}in the gpg man pages for more details.
Will be overridden by--build_gpgdirargument.
Don't remove~/.cache/pikaur/build/${PACKAGE_NAME}directory between the builds.
Will be overridden by-k/--keepbuildflag.
When building dev packages (-git,-svn,etc),
don't remove~/.cache/pikaur/build/${PACKAGE_NAME}directory between the builds.
Novalue will be overridden byKeepBuildDiroption and-k/--keepbuildflag.
Don't remove build dependencies between and after the builds.
Will be overridden by--keepbuilddepsflag.
Always skip the build if it fails and don't show recovery prompt.
When to isolate the build using systemd dynamic users.
(root- only when running as root)
Will be overridden by--dynamic-usersflag.
Ignore specified architectures (arch-array) in PKGBUILDs.
Always default to no when prompting to edit PKGBUILD and install files.
Don't prompt to edit PKGBUILD and install files.
Will be overridden by--noeditand--editflags.
Don't prompt to show the build files diff.
Will be overridden by--nodiffflag.
Flags to be passed togit diffcommand when reviewing build files.
Should be separated by commas (,).
Wherever to uselesspager when viewing AUR packages diff. Choices arealways,autoornever.
Hidegit difffor file paths, separated by commas (,).
Terminal colors, from 0 to 15:
Require enter key to be pressed when answering questions.
Print each command which pikaur is currently spawning.
Groups official packages by repository when using commands likepikaur -Ss <query>orpikaur <query>.
Sorting key for AUR packages when using commands likepikaur -Ss <query>orpikaur <query>.Acceptshottest,numvotes,lastmodified,popularity,pkgname.Onlypkgnameis sorted ascendingly. The metric forhottestis weighted by bothnumvotesandpopularity.
Display the date a package is last updated on search results when using commands likepikaur -Ss <query>orpikaur <query>.
Reverse search results of the commands likepikaur -Ss <query>orpikaur <query>.
Comma-separated list of packages names or globs, which upgrade should have additional warning message in the UI.
Print warning when using privilege escalation tool other thansudo.
Path to pacman executable.
Will be overriden by--pacman-pathflag.
PreserveEnv (default:PKGDEST,VISUAL,EDITOR,http_proxy,https_proxy,ftp_proxy,HTTP_PROXY,HTTPS_PROXY,FTP_PROXY,ALL_PROXY)
Preserve environment variables of current user when running pikaur as root (comma-separated).
Will be overriden by--preserve-envflag.
A tool used to escalate user privileges. Currently supported options aresudoanddoas.
Choices: pikaur, pacman. In case of elevating privilege for pacman - pikaur would ask for password every time pacman runs.
User ID to run makepkg if pikaur started from root. 0 - means disabled, not that it will use uid=0. Setting this option would override DynamicUsers settings and force changing to this UID instead of a dynamic one.
Path to package cache location.
Will be overridden by--xdg-cache-homeargument
or environment variableXDG_CACHE_HOME,if set.
Path to database location.
Will be overridden by--xdg-data-homeargument
or environment variableXDG_DATA_HOME,if set.
AurUrl (default:https://aur.archlinux.org)
AUR Host.
NewsUrl (default:https://archlinux.org/feeds/news/)
Arch Linux News URL, useful for users of Parabola or other Arch derivatives.
Specify a socks5 proxy which is used to get AUR package information.
The format is[host[:port]],and the default port is 1080.
PySocks module (python-pysockspackage) should be installed in order to use this option.
Note that any downloads bypacman,gitormakepkgwill NOT use this proxy.
If that's needed, setting proxy options in their own config files will take effect
(such as~/.gitconfig,~/.curlrc).
Specify a HTTP proxy which is used to get AUR package information and togit-clone from AUR.
Note that any downloads bypacman,git(inside the build) ormakepkgwill NOT use this proxy.
If that's needed, setting proxy options in their own config files will take effect
(such asenv HTTP_PROXY=,~/.gitconfig,~/.curlrc).
Specify a HTTPS proxy which is used to get AUR package information and togit-clone from AUR.
Note that any downloads bypacman,git(inside the build) ormakepkgwill NOT use this proxy.
If that's needed, setting proxy options in their own config files will take effect
(such asenv HTTPS_PROXY=,~/.gitconfig,~/.curlrc).
pikaur -Sua --devel --needed
(--neededoption will make sure what the same package version won't be rebuilt again and-a/--aurwill ensure what only AUR packages will be upgraded)
Pikaur is not needed for that, use just Pacman itself:
sudo pacman -Rs $(pacman -Qtdq)(howeverpikaur -Rs...would work as well if you lazy to typesudo:) )
SetSRCDEST,BUILDDIRorPKGDESTaccordingly inmakepkg.conf.
For more info seemakepkgdocumentation.
Usepaccache(8)with the--cachediroption.
To clean them up automatically, you may:
-
use a pacman hook. Start with the provided Copy
/usr/share/pikaur/examples/pikaur-cache.hookto/usr/share/libalpm/hooks/pikaur-cache-cleanup.hook, remember to update the cache's path. -
use a systemd service & timer (provided
pikaur-cache.serviceandpikaur-cache.timer). Configure it withsystemctl --user edit --full pikaur-cache.serviceand activate it withsystemctl --user enable --now pikaur-cache.timer.
Go to the package's directory,cd ~/.local/share/pikaur/aur_repos/${PACKAGE_NAME}.
Review the current PKGBUILD file changes withgit diffand then reset withgit checkout -- '*'.
Actually usecheckupdatestool to check the repo updates and use pikaur only for AUR (-a/--aurswitch):
checkupdates; pikaur -Qua 2>/dev/null
If you find the command takes a long time to initialize, make sure to periodically clear your cache:pikaur -Scc.Root pikaur is using SystemD Dynamic Users to isolate build process from the root, and it takes some time to change the owner of build cache to dynamic temporary user.
This will migrate the cache of what AUR packages have been installed, so you can still see a Git diff for the next update of each package:
mv~/.cache/yay/*~/.local/share/pikaur/aur_repos/
find~/.local/share/pikaur/aur_repos -mindepth 1 -maxdepth 1 -type d|xargs -r -I'{}'-- sh -c'cd "{}" && git rev-parse HEAD > last_installed.txt'This will show a list of commits to choose one to downgrade to.
pikaur -G<package>#retrieve package sources
cd<package>
git log#choose <commit> from the list
git checkout<commit>
pikaur -Pi#build and install older versionWhen using systemd dynamic users, by default, there is not a persistent user or gpg home directory. You can set the path to a persistent gpg home directory using the cli argument--build_gpgdir.Alternatively, you can set a permanent default with the configuration option[build] gpgdirin the root pikaur configuration file/root/.config/pikaur.confThe below example configures makepkg to use a hypothetical gpg home directory at/etc/pikaur.d/gnupgwhen validating source files.
[build]
gpgdir=/etc/pikaur.d/gnupgYou can initialize a minimal gnupghome at the example path by executing the below commands as root.
exportGNUPGHOME="/etc/pikaur.d/gnupg"
mkdir -p"${GNUPGHOME}"
gpg --batch --passphrase''--quick-gen-key"pikaur@localhost"rsa sign 0You can start fromthis list of issues.Grep-ing@TODOcomments also useful if you're itching to write something.
To install development deps, run:
pikaur -Pi./PKGBUILD_dev_depsmake -j lint./maintenance_scripts/docker_test.shSee also./maintenance_scripts/docker_test.sh --helpfor more options.
For example to run a single test inside docker:
./maintenance_scripts/docker_test.sh --local 1 pikaur_test.test_sysupgrade.SysupgradeTest.test_devel_upgradeTo start working on a new language, sayhi_IN(Indian Hindi):
- add it to the
MakefileLANGSvariable and runmake. - Then translate
locale/hi_IN.pousing your favorite PO editor (for examplegtranslator). - Run
makeevery time the Python code strings change or the.pois modified.
To see the list of authors, use this command inside pikaur git repository directory:
git log --pretty=tformat:"%an <%ae>"|sort -u@AladW (aurutils), @morganamilo (yay) during the early stages of Pikaur development. Andall the other issue contributorsfor helping in triaging the bugs and clearing up feature requirements.
