Difference between revisions of "AUR helpers"

From ArchWiki
Jump to: navigation, search
(Comparison table: nevermind, the "split" in nikola is deprecated by the maintainer...)
(Move Yay)
 
(297 intermediate revisions by 32 users not shown)
Line 1: Line 1:
 
[[Category:Package management]]
 
[[Category:Package management]]
 
[[de:AUR Hilfsprogramme]]
 
[[de:AUR Hilfsprogramme]]
 +
[[es:AUR helpers]]
 
[[fr:Assistants AUR]]
 
[[fr:Assistants AUR]]
 
[[ja:AUR ヘルパー]]
 
[[ja:AUR ヘルパー]]
 
[[pt:AUR helpers]]
 
[[pt:AUR helpers]]
 
[[ru:AUR helpers]]
 
[[ru:AUR helpers]]
[[tr:AUR Yardımcı Uygulamaları]]
 
 
[[zh-hans:AUR helpers]]
 
[[zh-hans:AUR helpers]]
{{Warning|None of these tools are [https://bbs.archlinux.org/viewtopic.php?pid=828254#p828254 officially] supported by Arch Linux. It is recommended to become familiar with the [[Arch User Repository#Installing packages|manual build process]] in order to be prepared to troubleshoot problems on one's own.}}
+
{{Warning|1=AUR helpers are '''not''' [https://bbs.archlinux.org/viewtopic.php?pid=828310#p828310 supported] by Arch Linux. It is recommended to become familiar with the [[Arch User Repository#Installing packages|manual build process]] in order to be prepared to troubleshoot problems on one's own.}}
 +
 
 +
{{Expansion|The intro could use more than a single sentence. See e.g. [https://old.reddit.com/r/archlinux/comments/8fqzf4/will_pacman_syu_also_update_the_stuff_i_have/dya3j0g/]}}
  
 
AUR helpers are written to automate certain tasks for the [[Arch User Repository]].
 
AUR helpers are written to automate certain tasks for the [[Arch User Repository]].
 
== Uploading ==
 
 
* [https://gist.github.com/bbidulock/82ab6f5347f021136054 bbidulock's script] — Migrate from a .backup directory with all packages.
 
* [https://github.com/JonnyJD/PKGBUILDs/blob/master/_bin/aur4_import.sh aur4_import.sh] — Splits a package from a git repository with multiple packages, adding/updating {{ic|.SRCINFO}} for every commit.
 
* [https://github.com/JonnyJD/PKGBUILDs/blob/master/_bin/aur4_make_submodule.sh aur4_make_submodule.sh] / [https://github.com/alexandre-mbm/arch-pkgs/blob/master/subaur4 subaur4] — Replaces a package in a bigger git repository with an AUR 4 submodule, including {{ic|.SRCINFO}}.
 
* [https://github.com/ido/packages-archlinux/blob/master/bin/import-to-aur4.sh import-to-aur4] — Splits an existing git repository into multiple AUR 4 packages, all at once, including {{ic|.SRCINFO}} for every commit.
 
* [https://github.com/Edenhofer/abs/blob/master/aurpublish aurpublish] — Manage AUR packages as [https://raw.githubusercontent.com/git/git/master/contrib/subtree/git-subtree.txt git subtrees]. The [https://github.com/Edenhofer/abs/blob/master/pre-commit.hook generation of {{ic|.SRCINFO}} files, {{ic|PKGBUILD}} checking] and the [https://github.com/Edenhofer/abs/blob/master/prepare-commit-msg.hook creation of a per package commit message template] is left to the git hooks in the same [https://github.com/Edenhofer/abs/blob/master/README.md repo].
 
  
 
== Build and search ==
 
== Build and search ==
  
This is a list of helper utilities that search, download and/or build packages.
+
{{Note|Do not edit this section prior to discussion in [[Talk:AUR helpers]].}}
 
 
* {{App|apacman|A fork of packer.|https://github.com/oshazard/apacman|{{AUR|apacman}}}}
 
 
 
* {{App|aura|A package manager for Arch Linux written in Haskell.|https://github.com/aurapm/aura|{{AUR|aura}} or {{AUR|aura-bin}} (binary)}}
 
 
 
* {{App|auracle|An AUR client written in C++.|https://github.com/falconindy/auracle|{{AUR|auracle-git}}}}
 
 
 
* {{App|aurel|2=Search, vote and download AUR packages from Emacs. ([https://bbs.archlinux.org/viewtopic.php?id=177142 Forum page])|3=https://github.com/alezost/aurel
 
|4={{AUR|aurel-git}}}}
 
 
 
* {{App|aurget|pacman-like interface to the AUR, without wrapping pacman commands.|https://github.com/pbrisbin/aurget/|{{AUR|aurget}}}}
 
 
 
* {{App|aurquery|Caching wrapper around the AUR's RPC interface using the python3-aur library.|http://xyne.archlinux.ca/projects/python3-aur|{{AUR|python3-aur}}}}
 
 
 
* {{App|aurutils|2=Helper tools for the AUR. ([https://bbs.archlinux.org/viewtopic.php?pid=1615428 Forum page])|3=https://github.com/AladW/aurutils|4={{AUR|aurutils}}}}
 
 
 
* {{App|bauerbill|2=Powerpill/pacman extension with support for building packages from ABS and AUR. ([https://bbs.archlinux.org/viewtopic.php?id=205834 Forum page])|3=http://xyne.archlinux.ca/projects/bauerbill|4={{AUR|bauerbill}}}}
 
 
* {{App|burgaur|A front-end for cower written in Python.|https://github.com/m45t3r/burgaur|{{AUR|burgaur}}}}
 
 
 
* {{App|cower|2=AUR search and download agent written in C, which also checks for updates and package dependencies. ([https://bbs.archlinux.org/viewtopic.php?id=97137 Forum page])|3=https://github.com/falconindy/cower|4={{AUR|cower}}}}
 
 
 
*{{App|cylon|pacman and pacaur wrapper, and is also a wrapper for cower and provides it a backend. Includes various other maintenance functions and extras.|https://github.com/gavinlyonsrepo/cylon|{{AUR|cylon}}}}
 
 
 
* {{App|owlman|2=pacman and cower wrapper ([https://bbs.archlinux.org/viewtopic.php?id=129609 Forum page])|3=https://github.com/baskerville/owlman|4={{AUR|owlman}}}}
 
 
 
* {{App|pacaur|2=An AUR helper that minimizes user interaction. ([https://bbs.archlinux.org/viewtopic.php?pid=937423 Forum page])|3=https://github.com/rmarquis/pacaur|4={{AUR|pacaur}}}}
 
 
 
* {{App|pacget|2=A wrapper around pacaur to mimic yaourt's search feature.|3=https://github.com/neurobin/pacget|4={{AUR|pacget}}}}
 
 
 
* {{App|packer|2=Wrapper for pacman and the AUR. ([https://bbs.archlinux.org/viewtopic.php?id=88115 Forum page])|3=https://github.com/keenerd/packer|4={{AUR|packer}}}}
 
 
 
* {{App|pamac|A DBus daemon and Gtk3 frontend for libalpm written in Vala.|https://github.com/manjaro/pamac/|{{AUR|pamac-aur}}}}
 
 
 
* {{App|pbget|Retrieve source files from the Arch SVN and CVS web interface, the AUR, and the ABS rsync server.|http://xyne.archlinux.ca/projects/pbget|{{AUR|pbget}}}}
 
 
 
* {{App|PKGBUILDer|An AUR helper with dependency support written in Python 3.|https://github.com/Kwpolska/pkgbuilder|{{AUR|pkgbuilder}}}}
 
 
 
* {{App|prm|An AUR and ABS helper.|https://git.fleshless.org/prm/|[https://pkg.fleshless.org/prm/plain/PKGBUILD PKGBUILD]}}
 
 
 
* {{App|repoctl|Tool to help manage local repositories (AUR support).|https://github.com/cassava/repoctl|{{AUR|repoctl}}}}
 
 
 
* {{App|spinach|An AUR helper written in Bash|http://www.floft.net/code/spinach/|{{AUR|spinach}}}}
 
 
 
* {{App|trizen|A  wrapper for the AUR written in Perl.|https://github.com/trizen/trizen|{{AUR|trizen}}}}
 
 
 
* {{App|wrapaur|A pacman and AUR wrapper written in bash.||{{AUR|wrapaur}}}}
 
 
 
* {{App|yaah|Yet another AUR helper|https://bitbucket.org/the_metalgamer/yaah|{{AUR|yaah}}}}
 
 
 
* {{App|yaourt|A  wrapper for the AUR and regular packages.|https://archlinux.fr/yaourt-en|{{AUR|yaourt}}}}
 
 
 
* {{App|yay|AUR helper written in Go.|https://github.com/Jguer/yay|{{AUR|yay}}}} or {{AUR|yay-bin}} (binary)
 
 
 
== Maintenance ==
 
 
 
* {{App|pkgbuild-watch|Looks for changes on the upstream web pages|http://kmkeen.com/pkgbuild-watch|{{AUR|pkgbuild-watch}}}}
 
 
 
* {{App|pkgbuildup|Helps AUR package maintainers automatically update PKGBUILD files. Supports a template variable syntax.|https://github.com/fasheng/pkgbuildup|{{AUR|pkgbuildup-git}}}}
 
 
 
* {{App|1=pkgcheck|2=Uses rules in PKGBUILDs to parse upstream version information or looks for changes by checksumming the web page|3=https://bbs.archlinux.org/viewtopic.php?id=162816|4=Repository: [https://github.com/onny/pkgcheck GitHub]}}
 
 
 
* {{App|pkgoutofdate|Parses the source URL from PKGBUILDs and tries to find new versions of packages by incrementing the version number and sending requests to the web server|https://github.com/anatol/pkgoutofdate|{{AUR|pkgoutofdate-git}}}}
 
 
 
* {{App|aur-check|Uses the AUR API to find newer versions of your foreign packages|https://gist.github.com/felipec/94752ddd08e1adfb80ac57947982443c}}
 
 
 
* {{App|updpkgver|Detects upstream releases and updates the PKGBUILD automatically|https://github.com/renatosilva/pactoys/tree/master/source/updpkgver}}
 
 
 
== Libraries ==
 
 
 
* {{App|haskell-archlinux|Library to access the AUR and package metadata from the Haskell programming language|http://hackage.haskell.org/package/archlinux|{{AUR|haskell-archlinux}}}}
 
 
 
* {{App|python3-aur|Python 3 modules for accessing AUR package information and automating AUR interactions.|http://xyne.archlinux.ca/projects/python3-aur|{{AUR|python3-aur}}}}
 
 
 
== Graphical ==
 
 
 
* {{App|1=Aarchup|2=Fork of archup. Has the same options as archup plus a few other features. For differences between both please check [https://bbs.archlinux.org/viewtopic.php?id=119129 changelog].|3=https://github.com/aericson/aarchup/|4={{AUR|aarchup}}}}
 
* {{App|1=Argon|2=Graphical frontend to pacaur, featuring package installation, removal, and updating; and update notifications for both official repository and AUR packages.|3=https://github.com/14mRh4X0r/arch-argon|4={{AUR|argon}}}}
 
* {{App|1=PkgBrowser|2=Application for searching and browsing Arch packages, showing details on selected packages.|3=https://bitbucket.org/kachelaqa/pkgbrowser/wiki/Home|4={{AUR|pkgbrowser}}}}
 
 
 
== Comparison table ==
 
  
 
The columns have the following meaning:
 
The columns have the following meaning:
Line 108: Line 21:
 
* ''Secure'': does not [[source]] the PKGBUILD at all by default; or, alerts the user and offers the opportunity to inspect the PKGBUILD manually before it is sourced. Some helpers are known to source PKGBUILDs before the user can inspect them, '''allowing malicious code to be executed'''. ''Optional'' means that there is a command line flag or configuration option to prevent the automatic sourcing before viewing.
 
* ''Secure'': does not [[source]] the PKGBUILD at all by default; or, alerts the user and offers the opportunity to inspect the PKGBUILD manually before it is sourced. Some helpers are known to source PKGBUILDs before the user can inspect them, '''allowing malicious code to be executed'''. ''Optional'' means that there is a command line flag or configuration option to prevent the automatic sourcing before viewing.
 
* ''Clean build'': does not export new variables that can prevent a successful build process.
 
* ''Clean build'': does not export new variables that can prevent a successful build process.
 +
* ''Native pacman'': when used as replacement for {{man|8|pacman}} commands such as {{ic|pacman -Syu}}, the following are obeyed ''by default'': [https://wiki.archlinux.org/index.php?title=Talk:AUR_helpers&oldid=515160#Add_.22pacman_wrap.22_column]
 +
:– do not separate commands, for example {{ic|pacman -Syu}} is not split to {{ic|pacman -Sy}} and {{ic|pacman -S ''packages''}};
 +
:– use ''pacman'' directly instead of manual database manipulation or usage of {{man|3|libalpm}}.
 +
:In addition, potentially [[System_maintenance#Avoid_certain_pacman_commands|harmful commands]] such as {{ic|pacman -Ud}}, {{ic|pacman -Rdd}}, {{ic|pacman --ask}} or {{ic|pacman --force}} are '''not''' used.
 +
:{{Warning|Notwithstanding these criteria, AUR helpers may deviate from {{man|8|pacman}} in various ways, in particular for installation of packages in the [[official repositories]]. Such usage is therefore '''not''' supported or recommended.}}
 
* ''Reliable parser'': ability to handle complex packages by using the provided metadata (RPC/.SRCINFO) instead of PKGBUILD [[w:Parsing#Parser|parsing]], such as {{AUR|aws-cli-git}}.
 
* ''Reliable parser'': ability to handle complex packages by using the provided metadata (RPC/.SRCINFO) instead of PKGBUILD [[w:Parsing#Parser|parsing]], such as {{AUR|aws-cli-git}}.
* ''Reliable solver'': ability to correctly solve and build complex dependency chains, such as {{AUR|plasma-git-meta}}.
+
* ''Reliable solver'': ability to correctly solve and build complex dependency chains, such as {{AUR|ros-lunar-desktop}}.
* ''Split packages'': ability to correctly build and install split packages independently.
+
* ''Split packages'': ability to correctly build and install:
* ''Git clone'': uses git clones instead of downloading tarballs (deprecated since AUR 4).
+
:– Multiple packages from the same package base, without rebuilding or reinstalling multiple times, such as {{AUR|clion}}
* ''Syntax'': P stands for [[Pacman]]-like, S for specific.
+
:– Split packages which depend on a package from the same package base, such as {{AUR|libc++}} and {{AUR|libc++abi}}.
 +
:– Split packages independently, such as {{AUR|python-pyalsaaudio}} and {{AUR|python2-pyalsaaudio}}.
 +
* ''Git clone'': uses {{man|1|git-clone}} by default to retrieve build files from the AUR.
 +
* ''Diff view'': ability to view package differences on inspection. Besides the PKGBUILD, this includes changes to files such as {{ic|.install}} or {{ic|.patch}} files.
 +
* ''Batch interaction'': ability to prompt in direct succession, in particular for:
 +
# Inspection of PKGBUILDs;
 +
# Summarizing package upgrades;
 +
# Resolution of package conflicts and installations.
 +
:An asterisk denotes functionality specifically enabled by the user.
 +
* ''Shell completion'': [[w:Command-line_completion|tab completion]] is available for the listed [[shell]]s.
  
{| class="wikitable sortable"
+
{{Note|<nowiki></nowiki>
! Name !! Written In !! Secure !! Clean build !! Reliable parser !! Reliable solver !! Split packages !! Git clone !! Shell completion !! Syntax !! Specificity
+
* Table rows are sorted by column values, where ''Yes'' or ''N/A'' take precedence over ''Partial'' or ''Optional'' and ''No'', or alphabetically if values are equal.
 +
* ''Optional'' means that a feature is available, but only through a command-line argument or configuration option. ''Partial'' means that a feature is not fully implemented, or that it partially deviates from the given criteria.}}
 +
 
 +
=== Active ===
 +
 
 +
{| class="wikitable sortable" width="100%"
 +
! Name !! Written In !! Secure !! Clean build !! Native pacman !! Reliable parser !! Reliable solver !! Split packages !! Git clone !! Diff view !! Batch interaction || Shell completion !! Specificity
 
|-
 
|-
! apacman
+
! {{AUR|aurman}}
| Bash || {{No}} [https://github.com/oshazard/apacman/issues/8] || {{No}} [https://github.com/oshazard/apacman/search?utf8=%E2%9C%93&q=export] || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | None || style="text-align:center;" |P || Fork of ''packer''
+
| Python || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{G|[https://github.com/polygamma/aurman/wiki/Description-of-the-aurman-dependency-solving Yes]}} || {{Yes}} || {{Yes}} || {{Yes}} || style="text-align:center;" | 1, [https://github.com/polygamma/aurman#question-5 2*, 3*] || style="text-align:center;" | bash, fish || fetch pgp keys, sort by votes/popularity, print news
 
|-
 
|-
! aura
+
! {{AUR|aurutils}}
| Haskell || {{Yes}} || {{Yes}} || {{No}} [https://github.com/aurapm/aura/issues/14] || {{No}} || {{No}} [https://github.com/aurapm/aura/issues/353] || {{No}} || style="text-align:center;" | bash/zsh || style="text-align:center;" |P || Downgrade, [[ABS]], [[powerpill]] support, multilingual, requires [[ArchHaskell]]
+
| Bash/C || {{Yes}} || {{Yes}} || {{Grey|N/A}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || style="text-align:center;" | 1 || style="text-align:center;" | zsh || [[vifm]], [[local repository]], [[package signing]], [[DeveloperWiki:Building_in_a_Clean_Chroot|clean chroot]] support, sort by votes/popularity
 
|-
 
|-
! auracle
+
! {{AUR|yay}}
| C++ || {{Yes}} || {{Grey|N/A}} || {{Yes}} || {{Yes}} || {{Grey|N/A}} || {{No}} || style="text-align:center;" | N/A || style="text-align:center;" | S || No automatic builds
+
| Go || {{Yes}} || {{Yes}} || {{Yes}} [https://github.com/Jguer/yay/commit/3bdb5343218d99d40f8a449b887348611f6bdbfc][https://github.com/Jguer/yay/commit/ea5a94e0f8bb5f76879099e6d319c0c0102231c2] || {{Yes}} || {{Yes}} || {{Yes}} || {{G|[https://github.com/Jguer/yay/pull/297 Yes]}} || {{G|[https://github.com/Jguer/yay/pull/447 Yes]}} || style="text-align:center;" | 1, [https://github.com/Jguer/yay/commit/3bdb5343218d99d40f8a449b887348611f6bdbfc 2*], [https://github.com/Jguer/yay/commit/ea5a94e0f8bb5f76879099e6d319c0c0102231c2 3*] || style="text-align:center;" | bash, fish, zsh || sort by votes, fetch PGP keys, [https://github.com/Jguer/yay/commit/4bcd3a6297052714e91e3f886602ce5c12d15786 prompt architecture]
 
|-
 
|-
! aurel
+
! {{AUR|pakku}}
| Emacs Lisp || {{Yes}} || {{Grey|N/A}} || {{Yes}} || {{Grey|N/A}} || {{Grey|N/A}} || {{No}} || style="text-align:center;" | N/A || style="text-align:center;" | S || Emacs integration, no automatic builds
+
| Nim || {{Yes}} || {{G|[https://github.com/kitsunyan/pakku/commit/864cc0373fd6095295f68cc44d1657bd17269732 Yes]}} || {{Y|[https://github.com/kitsunyan/pakku/wiki/Native-Pacman-Explanation Partial]}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{G|[https://github.com/kitsunyan/pakku/commit/396e9f44c4f5a79c7b9238835599387f6ff418fe Yes]}} || style="text-align:center;" | 1 || style="text-align:center;" | bash, zsh || [[ABS]] support, AUR comments, fetch PGP keys
 
|-
 
|-
! aurget
+
! {{AUR|pikaur}}
| Bash || {{Y|Optional}} || {{Yes}} || {{No}} || {{No}} || {{No}} [https://github.com/pbrisbin/aurget/issues/40] || {{No}} || style="text-align:center;" | bash/zsh || style="text-align:center;" | P || sort by votes
+
| Python || {{Yes}} || {{Yes}} || {{Y|[https://github.com/actionless/pikaur#pikaur Partial]}} || {{Yes}} || {{Yes}} || {{G|[https://github.com/actionless/pikaur/commit/d409b958b4ff403d4fda06681231061854d32b3c Yes]}} || {{Yes}} || {{Yes}} || style="text-align:center;" | 1, 2, 3 || style="text-align:center;" | bash, fish, zsh || [http://0pointer.net/blog/dynamic-users-with-systemd.html dynamic users], [https://github.com/actionless/pikaur/tree/master/locale multilingual], sort by votes/popularity, [https://github.com/actionless/pikaur/pull/191 print news]
 
|-
 
|-
! aurutils
+
! {{AUR|trizen}}
| Bash/C || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || style="text-align:center;" | zsh || style="text-align:center;" | S || [[vifm]], [[w:PCRE|PCRE]], [[local repository]], [[package signing]], [[systemd-nspawn]] support
+
| Perl || {{Yes}} || {{Yes}} || {{G|[https://github.com/trizen/trizen/commit/9e7b40e110175ea5bc7a0fa002ffadbf1106704b Yes]}} || {{G|[https://github.com/trizen/trizen/commit/7ab7ee5f9f1f5d971b731d092fc8e1dd963add4b Yes]}} || {{Yes}} || {{Y|[https://github.com/trizen/trizen/issues/46 Partial]}} || {{G|[https://github.com/trizen/trizen/commit/6fb0cc9e0ab66b8cca9493b0618ba4bab5fd2252 Yes]}} || {{Yes}} || style="text-align:center;" | 1* || style="text-align:center;" | bash, zsh, fish || Automatic builds by default, use {{ic|-G}} to disable, AUR comments
 
|-
 
|-
! bauerbill
+
! {{AUR|bauerbill}}
| Python || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || style="text-align:center;" | bash/zsh || style="text-align:center;" | P/S || Trust management, ABS support, extends Powerpill
+
| Python || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || style="text-align:center;" | 1 || style="text-align:center;" | bash, zsh || Trust management, [[ABS]] support, extends Powerpill  
 
|-
 
|-
! burgaur
+
! {{AUR|PKGBUILDer}}
| Python/C || {{Y|Optional}}, with [[mc]] || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | None || style="text-align:center;" | P || Wrapper for ''cower''
+
| Python || {{Y|Optional}} || {{Yes}} || {{G|[https://github.com/Kwpolska/pkgbuilder/blob/master/docs/wrapper.rst Yes]}} || {{Yes}} || {{Yes}} || {{Y|[https://github.com/Kwpolska/pkgbuilder/issues/39 Partial]}} || {{Yes}} || {{R|[https://github.com/Kwpolska/pkgbuilder/issues/36 No]}} || style="text-align:center;" | 1* || style="text-align:center;" | - || Automatic builds by default, use {{ic|-F}} to disable; multilingual
 
|-
 
|-
! owlman
+
! {{AUR|naaman}}
| Bash/C || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Y|Partial}} || {{No}} || style="text-align:center;" | None || style="text-align:center;" | S || Wrapper for ''cower''
+
| Python || {{Y|Optional}} || {{Yes}} || {{Grey|N/A}} || {{Yes}} || {{Y|[https://github.com/enckse/naaman/issues/19 Partial]}} || {{Y|[https://github.com/enckse/naaman/issues/20 Partial]}} || {{Yes}} || {{No}} || style="text-align:center;" | 1* || style="text-align:center;" | bash || Automatic builds by default, use {{ic|--fetch}} to disable, use {{ic|-d}} to enable the solver
 
|-
 
|-
! pacaur
+
! {{AUR|aura}}
| Bash/C || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || style="text-align:center;" | bash/zsh || style="text-align:center;" | P/S || Minimizes user interaction, multilingual, sort by votes/popularity
+
| Haskell || {{Y|Optional}} || {{Yes}} || {{G|[https://github.com/aurapm/aura/blob/master/aura/src/Aura/Pacman.hs Yes]}} || {{G|[https://github.com/aurapm/aura/commit/7848e9830cd880215f1d12a1c0294992428ea778 Yes]}} || {{No}} || {{R|[https://github.com/aurapm/aura/issues/353 No]}} || {{R|[https://github.com/aurapm/aura/pull/346 No]}} || {{Y|[https://github.com/aurapm/aura/blob/89bf702bd0539fa757265c4c54ea2192155f85ed/aura/src/Aura/Pkgbuild/Records.hs Partial]}} || style="text-align:center;"| 1* || style="text-align:center;" | bash, zsh || Automatic builds by default, use {{ic|--dryrun}} to disable, [[downgrade]] support, multilingual
 
|-
 
|-
! packer
+
! {{AUR|repofish}}
| Bash || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | None || style="text-align:center;" | P || -
+
| Bash || {{Y|Optional}} || {{Yes}} || {{Grey|N/A}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{Yes}} || style="text-align:center;" | 1* || style="text-align:center;" | - || Automatic builds by default, use {{ic|check}} or {{ic|update}} to disable, [[local repository]] support
 
|-
 
|-
! pbget
+
! {{AUR|wrapaur}}
| Python || {{Yes}} || {{Grey|N/A}} || {{Yes}} || {{Grey|N/A}} || {{Grey|N/A}} || {{Yes}} || style="text-align:center;" | None || style="text-align:center;" | S || No automatic builds
+
| Bash || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || style="text-align:center;" | - || style="text-align:center;" | - || Mirror updates, print news and AUR comments
 
|-
 
|-
! PKGBUILDer
+
! {{AUR|aurget}}
| Python || {{Y|Optional}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Y|Partial}} [https://github.com/Kwpolska/pkgbuilder/issues/39] || {{Yes}} || style="text-align:center;" | None || style="text-align:center;" | P || Automatic builds by default, use {{ic|-F}} to disable; multilingual
+
| Bash || {{Y|Optional}} || {{Yes}} || {{Grey|N/A}} || {{No}} || {{No}} || {{R|[https://github.com/pbrisbin/aurget/issues/40 No]}} || {{No}} || {{R|[https://github.com/pbrisbin/aurget/issues/41 No]}} || style="text-align:center;" | - || style="text-align:center;" | bash, zsh || sort by votes
 
|-
 
|-
! prm
+
|}
| Bash || {{Yes}} [https://git.fleshless.org/prm/commit/?id=e7252333b07975ea40f526269ce995e375e627bf] || {{Grey|N/A}} || {{Yes}} || {{Grey|N/A}} || {{Grey|N/A}} || {{Yes}} || style="text-align:center;" | None || style="text-align:center;" | S || No automatic builds, ABS support
+
 
 +
=== Search-only ===
 +
 
 +
{| class="wikitable sortable" width="100%"
 +
! Name !! Written In !! Secure !! Reliable parser !! Reliable solver !! Git clone !! Shell completion !! Specificity
 
|-
 
|-
! repoctl
+
! {{AUR|pbget}}
| Go || {{Yes}} || {{Grey|N/A}} || {{Yes}} [https://github.com/goulash/pacman/blob/master/aur/aur.go] || {{Grey|N/A}} || {{Grey|N/A}} || {{No}} || style="text-align:center;" | zsh || style="text-align:center;" | S || No automatic builds, local repository support
+
| Python || {{Yes}} || {{Yes}} || {{Grey|N/A}} || {{Yes}} || style="text-align:center;" | - || -
 
|-
 
|-
! spinach
+
! {{AUR|yaah}}
| Bash || {{No}} [https://github.com/floft/spinach/blob/master/spinach#L287] || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | None || style="text-align:center;" | S || -
+
| Bash || {{Yes}} || {{Yes}} || {{Grey|N/A}} || {{Y|Optional}} || style="text-align:center;" | bash || -
 
|-
 
|-
! trizen
+
! {{AUR|auracle-git}}
| Perl || {{Yes}} || {{Yes}} || {{Yes}} [https://github.com/trizen/trizen/commit/7ab7ee5f9f1f5d971b731d092fc8e1dd963add4b] || {{Yes}} || {{Yes}} [https://github.com/trizen/trizen/commit/3c94434c66ede793758f2bf7de84d68e3174e2ac] || {{Yes}} [https://github.com/trizen/trizen/commit/6fb0cc9e0ab66b8cca9493b0618ba4bab5fd2252] || style="text-align:center;" | None || style="text-align:center;" | P || AUR comments
+
| C++ || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || style="text-align:center;" | - || print build order
 
|-
 
|-
! wrapaur
+
! {{AUR|cower}}
| Bash || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{Yes}} || style="text-align:center;" | None || style="text-align:center;" | S || Mirror updates, print news and AUR comments
+
| || {{Yes}} || {{Yes}} || {{Grey|N/A}} || {{No}} || style="text-align:center;" | bash/zsh || regex support, sort by votes/popularity
 
|-
 
|-
! yaah
+
! {{AUR|package-query}}
| Bash || {{Yes}} || {{Grey|N/A}} || {{Yes}} || {{Grey|N/A}} || {{Grey|N/A}} || {{Y|Optional}} || style="text-align:center;" | bash || style="text-align:center;" | S || No automatic builds
+
| C || {{Yes}} || {{No}} [https://github.com/archlinuxfr/package-query/issues/135] || {{Grey|N/A}} || {{Grey|N/A}} || style="text-align:center;" | - || -
 
|-
 
|-
! yaourt
+
! {{AUR|repoctl}}
| Bash/C || {{No}} (''yaourt -Si'') [https://github.com/archlinuxfr/yaourt/blob/f373121d23d87031a24135fee593115832d803ec/src/lib/aur.sh#L47] [https://github.com/archlinuxfr/yaourt/blob/d9790e29cd7194535c793f51d185b7130a396916/src/lib/pkgbuild.sh.in#L415-L438] || {{No}} [https://lists.archlinux.org/pipermail/aur-general/2015-August/031314.html] || {{No}} || {{No}} [https://github.com/archlinuxfr/yaourt/issues/186] || {{No}} [https://github.com/archlinuxfr/yaourt/issues/85] || {{Y|Optional}} || style="text-align:center;" | bash/zsh/fish || style="text-align:center;" | P || Backup, ABS support, AUR comments, multilingual
+
| Go || {{Yes}} || {{Yes}} [https://github.com/goulash/pacman/blob/master/aur/aur.go] || {{Grey|N/A}} || {{No}} || style="text-align:center;" | zsh || local repository support
 
|-
 
|-
! yay
+
|}
| Go || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Y|Partial}} || {{No}} || style="text-align:center;" | bash/zsh/fish || style="text-align:center;" | P || sort by votes
+
 
 +
=== Discontinued or problematic ===
 +
 
 +
This table describes projects which either are discontinued by their authors, or have issues on ''Security'', ''Clean build'' or ''Native pacman'' (see [[#Build_and_search]]) unaddressed in the last 6 months.
 +
 
 +
{| class="wikitable sortable" width="100%"
 +
! Name !! Written In !! Secure !! Clean build !! Native pacman !! Reliable parser !! Reliable solver !! Split packages !! Git clone !! Diff view !! Batch interaction || Shell completion !! Specificity
 +
|-
 +
! {{AUR|aurel}} [https://bbs.archlinux.org/viewtopic.php?pid=1522459#p1522459]
 +
| Emacs Lisp || {{Yes}} || {{Grey|N/A}} || {{Grey|N/A}} || {{Grey|N/A}} || {{Grey|N/A}} || {{Grey|N/A}} || {{No}} || {{Grey|N/A}} || style="text-align:center;"|N/A || style="text-align:center;" | N/A || Emacs integration, no automatic builds
 +
|-
 +
! {{AUR|pacaur}} [https://bbs.archlinux.org/viewtopic.php?pid=1755144#p1755144]
 +
| Bash/C || {{Yes}} || {{Yes}} || {{R|[https://github.com/rmarquis/pacaur/commit/d8f49188452785fb28afc017baadd01d9e24ba21 No]}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || style="text-align:center;"| 1, 3 || style="text-align:center;" | bash, zsh || multilingual, sort by votes/popularity
 +
|-
 +
! {{AUR|spinach}} [https://github.com/floft/spinach]
 +
| Bash || {{G|[https://github.com/floft/spinach/commit/545574700812eb369b9537370f085ec9e5c3f01a Yes]}} || {{Yes}} || {{Grey|N/A}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | - || style="text-align:center;" | - || -
 +
|-
 +
! {{AUR|burgaur}} [https://github.com/m45t3r/burgaur/issues/7#issuecomment-365599675]
 +
| Python/C || {{Y|Optional}} || {{Yes}} || {{Grey|N/A}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | - || style="text-align:center;" | - || Wrapper for ''cower''
 +
|-
 +
! {{AUR|packer}}
 +
| Bash || {{No}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | - || style="text-align:center;" | - || -
 +
|-
 +
! {{AUR|yaourt}}
 +
| Bash/C || {{No}} [https://github.com/archlinuxfr/yaourt/blob/f373121d23d87031a24135fee593115832d803ec/src/lib/aur.sh#L47] [https://github.com/archlinuxfr/yaourt/blob/d9790e29cd7194535c793f51d185b7130a396916/src/lib/pkgbuild.sh.in#L415-L438] || {{R|[https://lists.archlinux.org/pipermail/aur-general/2015-August/031314.html No]}} || {{No}} || {{No}} || {{R|[https://github.com/archlinuxfr/yaourt/issues/186 No]}} || {{R|[https://github.com/archlinuxfr/yaourt/issues/85 No]}} || {{Y|Optional}} || {{Y|Optional}} || style="text-align:center;" | 2 || style="text-align:center;" | bash, zsh, fish || Backup, ABS support, print AUR comments, multilingual
 
|-
 
|-
 
|}
 
|}
  
{{Note|1=[[Pacman]] 4.2. introduced architecture specific fields. [http://allanmcrae.com/2014/12/pacman-4-2-released/] However, as of 06 April 2016, [[AurJson]] combines all entries in a single field: {{Bug|48796}}. Helpers relying on the RPC may use the below workarounds to retrieve dependencies:
+
== Libraries ==
* {{AUR|bauerbill}} [https://bbs.archlinux.org/viewtopic.php?pid=1617235#p1617235], {{AUR|pkgbuilder}} [https://github.com/Kwpolska/pkgbuilder/blob/65d9d74ef05f8996b81afb1cd005e3c337afa8b2/pkgbuilder/build.py#L198]: Retrieve specific fields from [[.SRCINFO]]
+
 
* {{AUR|aurutils}} [https://github.com/AladW/aurutils/issues/80], {{AUR|pacaur}} [https://github.com/rmarquis/pacaur/issues/465], {{AUR|trizen}} [https://github.com/trizen/trizen/commit/6a8ff9dc8cc83af783b8475dfbe89988dbc8a553]: Strip the {{ic|lib32-}} prefix on {{ic|i686}} systems
+
* {{App|haskell-archlinux|Library to access the AUR and package metadata from the Haskell programming language.|http://hackage.haskell.org/package/archlinux|{{AUR|haskell-archlinux}}}}
}}
+
 
 +
* {{App|python3-aur|Python 3 modules for accessing AUR package information and automating AUR interactions.|http://xyne.archlinux.ca/projects/python3-aur|{{AUR|python3-aur}}}}
 +
 
 +
== Maintenance ==
 +
 
 +
* {{App|aur-out-of-date|Uses hoster APIs to check AUR packages for upstream changes.|https://github.com/simon04/aur-out-of-date|{{AUR|aur-out-of-date}}}}
 +
 
 +
* {{App|pkgbuild-watch|Looks for changes on the upstream web pages.|http://kmkeen.com/pkgbuild-watch|{{AUR|pkgbuild-watch}}}}
 +
 
 +
* {{App|pkgbuildup|Helps AUR package maintainers automatically update PKGBUILD files. Supports a template variable syntax.|https://github.com/fasheng/pkgbuildup|{{AUR|pkgbuildup-git}}}}
 +
 
 +
* {{App|pkgoutofdate|Parses the source URL from PKGBUILDs and tries to find new versions of packages by incrementing the version number and sending requests to the web server.|https://github.com/anatol/pkgoutofdate|{{AUR|pkgoutofdate-git}}}}
 +
 
 +
== Uploading ==
 +
 
 +
* [https://github.com/JonnyJD/PKGBUILDs/blob/master/_bin/aur4_import.sh aur4_import.sh] — Splits a package from a git repository with multiple packages, adding/updating {{ic|.SRCINFO}} for every commit
 +
* [https://github.com/JonnyJD/PKGBUILDs/blob/master/_bin/aur4_make_submodule.sh aur4_make_submodule.sh] — Replaces a package in a bigger git repository with an AUR 4 submodule, including {{ic|.SRCINFO}}
 +
* [https://github.com/eli-schwartz/aurpublish aurpublish] — PKGBUILD management framework for AUR

Latest revision as of 15:44, 16 July 2018

Warning: AUR helpers are not supported by Arch Linux. It is recommended to become familiar with the manual build process in order to be prepared to troubleshoot problems on one's own.

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: The intro could use more than a single sentence. See e.g. [1] (Discuss in Talk:AUR helpers#)

AUR helpers are written to automate certain tasks for the Arch User Repository.

Build and search

Note: Do not edit this section prior to discussion in Talk:AUR helpers.

The columns have the following meaning:

  • Secure: does not source the PKGBUILD at all by default; or, alerts the user and offers the opportunity to inspect the PKGBUILD manually before it is sourced. Some helpers are known to source PKGBUILDs before the user can inspect them, allowing malicious code to be executed. Optional means that there is a command line flag or configuration option to prevent the automatic sourcing before viewing.
  • Clean build: does not export new variables that can prevent a successful build process.
  • Native pacman: when used as replacement for pacman(8) commands such as pacman -Syu, the following are obeyed by default: [2]
– do not separate commands, for example pacman -Syu is not split to pacman -Sy and pacman -S packages;
– use pacman directly instead of manual database manipulation or usage of libalpm(3).
In addition, potentially harmful commands such as pacman -Ud, pacman -Rdd, pacman --ask or pacman --force are not used.
Warning: Notwithstanding these criteria, AUR helpers may deviate from pacman(8) in various ways, in particular for installation of packages in the official repositories. Such usage is therefore not supported or recommended.
  • Reliable parser: ability to handle complex packages by using the provided metadata (RPC/.SRCINFO) instead of PKGBUILD parsing, such as aws-cli-gitAUR.
  • Reliable solver: ability to correctly solve and build complex dependency chains, such as ros-lunar-desktopAUR.
  • Split packages: ability to correctly build and install:
– Multiple packages from the same package base, without rebuilding or reinstalling multiple times, such as clionAUR
– Split packages which depend on a package from the same package base, such as libc++AUR and libc++abiAUR.
– Split packages independently, such as python-pyalsaaudioAUR and python2-pyalsaaudioAUR.
  • Git clone: uses git-clone(1) by default to retrieve build files from the AUR.
  • Diff view: ability to view package differences on inspection. Besides the PKGBUILD, this includes changes to files such as .install or .patch files.
  • Batch interaction: ability to prompt in direct succession, in particular for:
  1. Inspection of PKGBUILDs;
  2. Summarizing package upgrades;
  3. Resolution of package conflicts and installations.
An asterisk denotes functionality specifically enabled by the user.
Note:
  • Table rows are sorted by column values, where Yes or N/A take precedence over Partial or Optional and No, or alphabetically if values are equal.
  • Optional means that a feature is available, but only through a command-line argument or configuration option. Partial means that a feature is not fully implemented, or that it partially deviates from the given criteria.

Active

Name Written In Secure Clean build Native pacman Reliable parser Reliable solver Split packages Git clone Diff view Batch interaction Shell completion Specificity
aurmanAUR Python Yes Yes Yes Yes Yes Yes Yes Yes 1, 2*, 3* bash, fish fetch pgp keys, sort by votes/popularity, print news
aurutilsAUR Bash/C Yes Yes N/A Yes Yes Yes Yes Yes 1 zsh vifm, local repository, package signing, clean chroot support, sort by votes/popularity
yayAUR Go Yes Yes Yes [3][4] Yes Yes Yes Yes Yes 1, 2*, 3* bash, fish, zsh sort by votes, fetch PGP keys, prompt architecture
pakkuAUR Nim Yes Yes Partial Yes Yes Yes Yes Yes 1 bash, zsh ABS support, AUR comments, fetch PGP keys
pikaurAUR Python Yes Yes Partial Yes Yes Yes Yes Yes 1, 2, 3 bash, fish, zsh dynamic users, multilingual, sort by votes/popularity, print news
trizenAUR Perl Yes Yes Yes Yes Yes Partial Yes Yes 1* bash, zsh, fish Automatic builds by default, use -G to disable, AUR comments
bauerbillAUR Python Yes Yes Yes Yes Yes Yes Yes No 1 bash, zsh Trust management, ABS support, extends Powerpill
PKGBUILDerAUR Python Optional Yes Yes Yes Yes Partial Yes No 1* - Automatic builds by default, use -F to disable; multilingual
naamanAUR Python Optional Yes N/A Yes Partial Partial Yes No 1* bash Automatic builds by default, use --fetch to disable, use -d to enable the solver
auraAUR Haskell Optional Yes Yes Yes No No No Partial 1* bash, zsh Automatic builds by default, use --dryrun to disable, downgrade support, multilingual
repofishAUR Bash Optional Yes N/A No No No Yes Yes 1* - Automatic builds by default, use check or update to disable, local repository support
wrapaurAUR Bash Yes Yes Yes No No No Yes No - - Mirror updates, print news and AUR comments
aurgetAUR Bash Optional Yes N/A No No No No No - bash, zsh sort by votes

Search-only

Name Written In Secure Reliable parser Reliable solver Git clone Shell completion Specificity
pbgetAUR Python Yes Yes N/A Yes - -
yaahAUR Bash Yes Yes N/A Optional bash -
auracle-gitAUR C++ Yes Yes Yes No - print build order
cowerAUR C Yes Yes N/A No bash/zsh regex support, sort by votes/popularity
package-queryAUR C Yes No [5] N/A N/A - -
repoctlAUR Go Yes Yes [6] N/A No zsh local repository support

Discontinued or problematic

This table describes projects which either are discontinued by their authors, or have issues on Security, Clean build or Native pacman (see #Build_and_search) unaddressed in the last 6 months.

Name Written In Secure Clean build Native pacman Reliable parser Reliable solver Split packages Git clone Diff view Batch interaction Shell completion Specificity
aurelAUR [7] Emacs Lisp Yes N/A N/A N/A N/A N/A No N/A N/A N/A Emacs integration, no automatic builds
pacaurAUR [8] Bash/C Yes Yes No Yes Yes Yes Yes Yes 1, 3 bash, zsh multilingual, sort by votes/popularity
spinachAUR [9] Bash Yes Yes N/A No No No No No - - -
burgaurAUR [10] Python/C Optional Yes N/A No No No No No - - Wrapper for cower
packerAUR Bash No Yes Yes No No No No No - - -
yaourtAUR Bash/C No [11] [12] No No No No No Optional Optional 2 bash, zsh, fish Backup, ABS support, print AUR comments, multilingual

Libraries

  • haskell-archlinux — Library to access the AUR and package metadata from the Haskell programming language.
http://hackage.haskell.org/package/archlinux || haskell-archlinuxAUR
  • python3-aur — Python 3 modules for accessing AUR package information and automating AUR interactions.
http://xyne.archlinux.ca/projects/python3-aur || python3-aurAUR

Maintenance

  • aur-out-of-date — Uses hoster APIs to check AUR packages for upstream changes.
https://github.com/simon04/aur-out-of-date || aur-out-of-dateAUR
  • pkgbuild-watch — Looks for changes on the upstream web pages.
http://kmkeen.com/pkgbuild-watch || pkgbuild-watchAUR
  • pkgbuildup — Helps AUR package maintainers automatically update PKGBUILD files. Supports a template variable syntax.
https://github.com/fasheng/pkgbuildup || pkgbuildup-gitAUR
  • pkgoutofdate — Parses the source URL from PKGBUILDs and tries to find new versions of packages by incrementing the version number and sending requests to the web server.
https://github.com/anatol/pkgoutofdate || pkgoutofdate-gitAUR

Uploading

  • aur4_import.sh — Splits a package from a git repository with multiple packages, adding/updating .SRCINFO for every commit
  • aur4_make_submodule.sh — Replaces a package in a bigger git repository with an AUR 4 submodule, including .SRCINFO
  • aurpublish — PKGBUILD management framework for AUR