Difference between revisions of "AUR helpers"

From ArchWiki
Jump to navigation Jump to search
(Move Yay)
(add precise definition of what AUR helpers do, merged Alad draft)
 
(242 intermediate revisions by 18 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Package management]]
 
[[Category:Package management]]
 +
[[Category:Software comparisons]]
 
[[de:AUR Hilfsprogramme]]
 
[[de:AUR Hilfsprogramme]]
 
[[es:AUR helpers]]
 
[[es:AUR helpers]]
Line 7: Line 9:
 
[[ru:AUR helpers]]
 
[[ru:AUR helpers]]
 
[[zh-hans:AUR helpers]]
 
[[zh-hans:AUR helpers]]
{{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.}}
+
{{Warning|1=AUR helpers are '''not supported''' by Arch Linux. You should become familiar with the [[Arch User Repository#Installing packages|manual build process]] in order to be prepared to troubleshoot problems.}}
 +
{{Note|Please use the discussion page to suggest edits to this article: [[Talk:AUR helpers]].}}
  
{{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 automate usage of the [[Arch User Repository]]. In particular, they may automate the following tasks:
  
AUR helpers are written to automate certain tasks for the [[Arch User Repository]].
+
* searching for packages published on the AUR;
 +
* resolving of dependencies between AUR packages;
 +
* retrieve and build AUR packages;
 +
* retrieve web content, such as user comments;
 +
* submission of AUR packages.
  
== Build and search ==
+
[[Pacman]] only handles updates for pre-built packages in its repositories. AUR packages are redistributed in form of [[PKGBUILD]]s and need an AUR helper to automate the re-build process. However, keep in mind that a rebuild of package may be required when its shared library dependencies are updated, not only when the package itself is updated.
  
{{Note|Do not edit this section prior to discussion in [[Talk:AUR helpers]].}}
+
== Legend ==
  
The columns have the following meaning:
+
The [[#Comparison tables]] 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.
+
;File review: 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'''.
* ''Clean build'': does not export new variables that can prevent a successful build process.
+
;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.
* ''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]
+
;Git clone: Uses {{man|1|git-clone}} by default to retrieve build files from the AUR.
:– do not separate commands, for example {{ic|pacman -Syu}} is not split to {{ic|pacman -Sy}} and {{ic|pacman -S ''packages''}};
+
;Reliable parser: Ability to handle complex packages by using the provided metadata ([[Aurweb RPC interface|RPC]]/.SRCINFO) instead of PKGBUILD [[w:Parsing#Parser|parsing]], such as {{AUR|aws-cli-git}}.
:– use ''pacman'' directly instead of manual database manipulation or usage of {{man|3|libalpm}}.
+
;Reliable solver: Ability to correctly solve and build complex dependency chains, such as {{AUR|ros-lunar-desktop}}.
: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.
+
;Split packages: Ability to correctly build and install:
:{{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.}}
+
:* Multiple packages from the same package base, without rebuilding or reinstalling multiple times, such as {{AUR|clion}}
* ''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}}.
+
:* Split packages which depend on a package from the same package base, such as {{AUR|libc++}} and {{AUR|libc++abi}}.
* ''Reliable solver'': ability to correctly solve and build complex dependency chains, such as {{AUR|ros-lunar-desktop}}.
+
:* Split packages independently, such as {{AUR|python-pyalsaaudio}} and {{AUR|python2-pyalsaaudio}}.
* ''Split packages'': ability to correctly build and install:
+
;Batch interaction: Ability to prompt before the build process and package transactions, in particular:
:Multiple packages from the same package base, without rebuilding or reinstalling multiple times, such as {{AUR|clion}}
+
:# Combined summary of repository and AUR package upgrades;
:Split packages which depend on a package from the same package base, such as {{AUR|libc++}} and {{AUR|libc++abi}}.
+
:# Resolution of package conflicts and choice of providers.
:Split packages independently, such as {{AUR|python-pyalsaaudio}} and {{AUR|python2-pyalsaaudio}}.
+
;Shell completion: [[w:Command-line_completion|Tab completion]] is available for the listed [[shell]]s.
* ''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.
 
  
{{Note|<nowiki></nowiki>
+
{{Note|''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.}}
* 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 ===
+
== Comparison tables ==
  
{| class="wikitable sortable" width="100%"
+
=== Search and download ===
! Name !! Written In !! Secure !! Clean build !! Native pacman !! Reliable parser !! Reliable solver !! Split packages !! Git clone !! Diff view !! Batch interaction || Shell completion !! Specificity
+
 
 +
{| class="wikitable sortable" style="text-align: center;"
 +
! Name !! Written in !! Git clone !! Reliable parser !! Reliable solver !! Shell completion !! Specificity
 
|-
 
|-
! {{AUR|aurman}}
+
! {{AUR|auracle-git}}
| 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
+
| C++ || {{Yes|https://github.com/falconindy/auracle/commit/c73bbee}} || {{Yes}} || {{Yes}} || bash || {{L|print build order}}
 
|-
 
|-
! {{AUR|aurutils}}
+
! {{AUR|pbget}}
| 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
+
| Python || {{Yes}} || {{Yes}} || {{-}} || {{-}} || {{-}}
 
|-
 
|-
! {{AUR|yay}}
+
! {{AUR|repoctl}}
| 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]
+
| Go || {{No}} || {{Yes|https://github.com/goulash/pacman/blob/master/aur/aur.go}} || {{-}} || zsh || {{L|[[local repository]]}}
 
|-
 
|-
! {{AUR|pakku}}
+
! {{AUR|yaah}}
| 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
+
| Bash || {{Y|Optional}} || {{Yes}} || {{-}} || bash || {{-}}
 
|-
 
|-
! {{AUR|pikaur}}
+
! {{Grey|1={{AUR|aurel}} <br> <small>([https://bbs.archlinux.org/viewtopic.php?pid=1522459#p1522459 discontinued])</small>}}
| 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]
+
| Emacs Lisp || {{No}} || {{Yes}} || {{-}} || {{-}} || {{L|[[emacs]] integration}}
 +
|}
 +
 
 +
=== Search and build ===
 +
 
 +
{| class="wikitable sortable" style="text-align: center;"
 +
! Name !! Written in !! File review !! Diff view !! Git clone !! Reliable parser !! Reliable solver !! Split packages !! Shell completion !! Specificity
 
|-
 
|-
! {{AUR|trizen}}
+
! {{AUR|aurutils}}
| 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
+
| Bash/C || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || bash, zsh || {{L|[[w:Modular programming|modular]], [[local repository]], [[package signing]], [[DeveloperWiki:Building in a clean chroot|clean chroot]]}}
 
|-
 
|-
 
! {{AUR|bauerbill}}
 
! {{AUR|bauerbill}}
| 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
+
| Python || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || bash, zsh || {{L|{{ic|bb-wrapper}} for ''pacman'' wrapping, trust management}}
 
|-
 
|-
 
! {{AUR|PKGBUILDer}}
 
! {{AUR|PKGBUILDer}}
| 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
+
| Python || {{No}} || {{No|https://github.com/Kwpolska/pkgbuilder/issues/36}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Y|[https://github.com/Kwpolska/pkgbuilder/issues/39 Partial]}} || {{-}} || {{L|{{ic|pb}} for ''pacman'' wrapping}}
|-
 
! {{AUR|naaman}}
 
| 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
 
|-
 
! {{AUR|aura}}
 
| 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
 
 
|-
 
|-
 
! {{AUR|repofish}}
 
! {{AUR|repofish}}
| 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
+
| Bash || {{No}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{-}} || {{L|[[local repository]]}}
|-
 
! {{AUR|wrapaur}}
 
| Bash || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || style="text-align:center;" | - || style="text-align:center;" | - || Mirror updates, print news and AUR comments
 
|-
 
! {{AUR|aurget}}
 
| 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
 
|-
 
|}
 
 
 
=== Search-only ===
 
 
 
{| class="wikitable sortable" width="100%"
 
! Name !! Written In !! Secure !! Reliable parser !! Reliable solver !! Git clone !! Shell completion !! Specificity
 
|-
 
! {{AUR|pbget}}
 
| Python || {{Yes}} || {{Yes}} || {{Grey|N/A}} || {{Yes}} || style="text-align:center;" | - || -
 
|-
 
! {{AUR|yaah}}
 
| Bash || {{Yes}} || {{Yes}} || {{Grey|N/A}} || {{Y|Optional}} || style="text-align:center;" | bash || -
 
|-
 
! {{AUR|auracle-git}}
 
| C++ || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || style="text-align:center;" | - || print build order
 
|-
 
! {{AUR|cower}}
 
| C  || {{Yes}} || {{Yes}} || {{Grey|N/A}} || {{No}} || style="text-align:center;" | bash/zsh || regex support, sort by votes/popularity
 
 
|-
 
|-
! {{AUR|package-query}}
+
! {{AUR|rua}}
| C || {{Yes}} || {{No}} [https://github.com/archlinuxfr/package-query/issues/135] || {{Grey|N/A}} || {{Grey|N/A}} || style="text-align:center;" | - || -
+
| Rust || {{Yes}} || {{Yes|https://github.com/vn971/rua/commit/0459a8b}} || {{Yes}} || {{Yes|https://github.com/vn971/rua/commit/fc8c2f3}} || {{Yes}} || {{Yes|https://github.com/vn971/rua/commit/7889045}} || bash, zsh, fish || {{L|[[bubblewrap]], {{ic|.pkg.tar}} inspection}}
 
|-
 
|-
! {{AUR|repoctl}}
+
! {{Grey|{{AUR|aurget}} <br> <small>([https://github.com/pbrisbin/aurget/issues/66#issue-485245712 discontinued])</small>}}
| 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
+
| Bash || {{No}} || {{No|https://github.com/pbrisbin/aurget/issues/41}} || {{No}} || {{No}} || {{No}} || {{No|https://github.com/pbrisbin/aurget/issues/40}} || bash, zsh || {{-}}
 
|-
 
|-
 +
! {{Grey|{{AUR|spinach}} <br> <small>([https://github.com/floft/spinach discontinued])</small>}}
 +
| Bash || {{Yes|https://github.com/floft/spinach/commit/5455747}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{-}} || {{-}}
 
|}
 
|}
  
=== Discontinued or problematic ===
+
=== Pacman wrappers ===
  
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.
+
{{Warning|{{man|8|pacman}} wrappers abstract the work of the package manager. They may (optionally or by default) introduce [[System_maintenance#Avoid_certain_pacman_commands|unsafe flags]], or other unexpected behavior leading to a defective system.}}
  
{| class="wikitable sortable" width="100%"
+
{| class="wikitable sortable" style="text-align: center;"
! Name !! Written In !! Secure !! Clean build !! Native pacman !! Reliable parser !! Reliable solver !! Split packages !! Git clone !! Diff view !! Batch interaction || Shell completion !! Specificity
+
! Name !! Written in !! File review !! Diff view !! Git clone !! Reliable parser !! Reliable solver !! Split packages !! Unsafe flags !! Shell completion !! Specificity
 
|-
 
|-
! {{AUR|aurel}} [https://bbs.archlinux.org/viewtopic.php?pid=1522459#p1522459]
+
! {{AUR|aura}}
| 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
+
| Haskell || {{No}} || {{Y|[https://github.com/aurapm/aura/blob/89bf702/aura/src/Aura/Pkgbuild/Records.hs Partial]}} || {{No|https://github.com/aurapm/aura/pull/346}} || {{Yes|https://github.com/aurapm/aura/commit/7848e983}} || {{No}} || {{No|https://github.com/aurapm/aura/issues/353}} || {{-}} || bash, zsh || {{-}}
 
|-
 
|-
! {{AUR|pacaur}} [https://bbs.archlinux.org/viewtopic.php?pid=1755144#p1755144]
+
! {{AUR|pacaur}}
| 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
+
| Bash/C || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || [https://github.com/rmarquis/pacaur/commit/12707cc --ask] || bash, zsh || {{L|batch interaction 2}}
 
|-
 
|-
! {{AUR|spinach}} [https://github.com/floft/spinach]
+
! {{AUR|pakku}}
| 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;" | - || -
+
| Nim || {{Yes}} || {{Yes|https://github.com/kitsunyan/pakku/commit/396e9f4}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || [https://github.com/kitsunyan/pakku/wiki/Native-Pacman-Explanation -Sy] || bash, zsh || {{L|fetch PGP keys}}
 
|-
 
|-
! {{AUR|burgaur}} [https://github.com/m45t3r/burgaur/issues/7#issuecomment-365599675]
+
! {{AUR|pikaur}}
| Python/C || {{Y|Optional}} || {{Yes}} || {{Grey|N/A}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | - || style="text-align:center;" | - || Wrapper for ''cower''
+
| Python || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || [https://github.com/actionless/pikaur#pikaur -Sy] || bash, fish, zsh || {{L|batch interaction 1/2, [http://0pointer.net/blog/dynamic-users-with-systemd.html dynamic users]}}
 
|-
 
|-
! {{AUR|packer}}
+
! {{AUR|trizen}}
| Bash || {{No}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | - || style="text-align:center;" | - || -
+
| Perl || {{Yes}} || {{Yes}} ||{{Yes|https://github.com/trizen/trizen/commit/6fb0cc9}} || {{Yes|https://github.com/trizen/trizen/commit/7ab7ee5f}} || {{Yes}} || {{Y|[https://github.com/trizen/trizen/issues/46 Partial]}} || {{-}} || bash, fish, zsh || {{-}}
 
|-
 
|-
! {{AUR|yaourt}}
+
! {{AUR|yay}}
| 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
+
| Go || {{Yes}} || {{Yes|https://github.com/Jguer/yay/pull/447}} || {{Yes|https://github.com/Jguer/yay/pull/297}} || {{Yes}} || {{Yes|https://github.com/Jguer/yay/pull/866}} || {{Yes}} || [https://github.com/Jguer/yay/commit/3bdb534 -Sy*]<br>[https://github.com/Jguer/yay/commit/ea5a94e --ask*] || bash, fish, zsh || {{L|batch interaction 1/2, fetch PGP keys}}
 
|-
 
|-
 +
! {{Grey|{{AUR|aurman}} <br> <small>([https://github.com/polygamma/aurman#stopped-development-for-public-use discontinued])</small>}}
 +
| Python || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No|https://github.com/polygamma/aurman/issues/259}} || {{Yes}} || [https://github.com/polygamma/aurman/commit/6c02ba3 -Sy*]<br>[https://github.com/polygamma/aurman#make-use-of-the-undocumented---ask-flag-of-pacman --ask*] || bash, fish || {{L|batch interaction 1/2, fetch PGP keys}}
 
|}
 
|}
  
== Libraries ==
+
== Graphical ==
  
* {{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}}}}
+
{{Warning|Usage of graphical AUR helpers may lead to a defective system, for example through unattended [[partial upgrades]].}}
 
+
* {{App|Argon|GTK 3 pacman wrapper written in Python.|https://github.com/14mRh4X0r/arch-argon|{{AUR|argon}}}}
* {{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}}}}
+
* {{App|Cylon|TUI pacman wrapper written in Bash.|https://github.com/gavinlyonsrepo/cylon|{{AUR|cylon}}}}
 +
* {{App|Pamac|Standalone GTK 3 package manager using {{man|3|libalpm}} written in Vala.|https://gitlab.manjaro.org/applications/pamac|{{AUR|pamac-aur}}}}
 +
* {{App|Pakku GUI|GTK 3 frontend for pakku written in Python.|https://gitlab.com/mrvik/pakku-gui|{{AUR|pakku-gui}}}}
 +
* {{App|PkgBrowser|Qt 5 read-only browser for repository packages and AUR written in Python.|https://bitbucket.org/kachelaqa/pkgbrowser|{{AUR|pkgbrowser}}}}
 +
* {{App|Octopi|Qt 5 pacman wrapper written in C++.|https://octopiproject.wordpress.com/|{{AUR|octopi}}}}
  
 
== Maintenance ==
 
== 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|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|aurpublish|Helper script to manage and upload AUR packages using {{man|1|git-subtree}}. Uses {{man|5|githooks}} to verify the PKGBUILD integrity, generate .SRCINFO automatically, and create a commit message template.|https://github.com/eli-schwartz/aurpublish|{{Pkg|aurpublish}}}}
 +
* {{App|[[DeveloperWiki:Building in a clean chroot|devtools]]|Build packages in a clean environment ([[systemd-nspawn]] container) to ensure their correctness. Wrapped by {{AUR|aurutils}} and {{AUR|clean-chroot-manager}}.|https://git.archlinux.org/devtools.git/|{{Pkg|devtools}}}}
 
* {{App|pkgbuild-watch|Looks for changes on the upstream web pages.|http://kmkeen.com/pkgbuild-watch|{{AUR|pkgbuild-watch}}}}
 
* {{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|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}}}}
 
* {{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 ==
+
== Other ==
  
* [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
+
* {{App|aur-talk|Fetch and display AUR comments.|https://github.com/GermainZ/aur-talk|{{AUR|aur-talk-git}}}}
* [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}}
+
* {{App|aurvote-utils|A set of utilities for managing AUR votes.|https://github.com/jadenPete/aurvote-utils|{{AUR|aurvote-utils}}}}
* [https://github.com/eli-schwartz/aurpublish aurpublish] — PKGBUILD management framework for AUR
+
* {{App|haskell-aur|Haskell library for accessing Aurweb RPC interface.|https://hackage.haskell.org/package/aur|{{AUR|haskell-aur}}}}
 +
* {{App|package-query|Tool for querying {{man|3|libalpm}} and the AUR.|https://github.com/archlinuxfr/package-query|{{AUR|package-query}}}}
 +
* {{App|python3-aur|Python 3 modules and helper utilities for accessing AUR package information and automating AUR interactions.|https://xyne.archlinux.ca/projects/python3-aur|{{AUR|python3-aur}}}}
 +
* {{App|raur|Rust library for accessing [[Aurweb RPC interface]].|https://gitlab.com/davidbittner/raur||}}

Latest revision as of 23:10, 10 December 2019

Warning: AUR helpers are not supported by Arch Linux. You should become familiar with the manual build process in order to be prepared to troubleshoot problems.
Note: Please use the discussion page to suggest edits to this article: Talk:AUR helpers.

AUR helpers automate usage of the Arch User Repository. In particular, they may automate the following tasks:

  • searching for packages published on the AUR;
  • resolving of dependencies between AUR packages;
  • retrieve and build AUR packages;
  • retrieve web content, such as user comments;
  • submission of AUR packages.

Pacman only handles updates for pre-built packages in its repositories. AUR packages are redistributed in form of PKGBUILDs and need an AUR helper to automate the re-build process. However, keep in mind that a rebuild of package may be required when its shared library dependencies are updated, not only when the package itself is updated.

Legend

The #Comparison tables columns have the following meaning:

File review
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.
Diff view
Ability to view package differences on inspection. Besides the PKGBUILD, this includes changes to files such as .install or .patch files.
Git clone
Uses git-clone(1) by default to retrieve build files from the AUR.
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.
Batch interaction
Ability to prompt before the build process and package transactions, in particular:
  1. Combined summary of repository and AUR package upgrades;
  2. Resolution of package conflicts and choice of providers.
Shell completion
Tab completion is available for the listed shells.
Note: 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.

Comparison tables

Search and download

Name Written in Git clone Reliable parser Reliable solver Shell completion Specificity
auracle-gitAUR C++ Yes Yes Yes bash print build order
pbgetAUR Python Yes Yes
repoctlAUR Go No Yes zsh local repository
yaahAUR Bash Optional Yes bash
aurelAUR
(discontinued)
Emacs Lisp No Yes emacs integration

Search and build

Name Written in File review Diff view Git clone Reliable parser Reliable solver Split packages Shell completion Specificity
aurutilsAUR Bash/C Yes Yes Yes Yes Yes Yes bash, zsh modular, local repository, package signing, clean chroot
bauerbillAUR Python Yes No Yes Yes Yes Yes bash, zsh bb-wrapper for pacman wrapping, trust management
PKGBUILDerAUR Python No No Yes Yes Yes Partial pb for pacman wrapping
repofishAUR Bash No Yes Yes No No No local repository
ruaAUR Rust Yes Yes Yes Yes Yes Yes bash, zsh, fish bubblewrap, .pkg.tar inspection
aurgetAUR
(discontinued)
Bash No No No No No No bash, zsh
spinachAUR
(discontinued)
Bash Yes No No No No No

Pacman wrappers

Warning: pacman(8) wrappers abstract the work of the package manager. They may (optionally or by default) introduce unsafe flags, or other unexpected behavior leading to a defective system.
Name Written in File review Diff view Git clone Reliable parser Reliable solver Split packages Unsafe flags Shell completion Specificity
auraAUR Haskell No Partial No Yes No No bash, zsh
pacaurAUR Bash/C Yes Yes Yes Yes Yes Yes --ask bash, zsh batch interaction 2
pakkuAUR Nim Yes Yes Yes Yes Yes Yes -Sy bash, zsh fetch PGP keys
pikaurAUR Python Yes Yes Yes Yes Yes Yes -Sy bash, fish, zsh batch interaction 1/2, dynamic users
trizenAUR Perl Yes Yes Yes Yes Yes Partial bash, fish, zsh
yayAUR Go Yes Yes Yes Yes Yes Yes -Sy*
--ask*
bash, fish, zsh batch interaction 1/2, fetch PGP keys
aurmanAUR
(discontinued)
Python Yes Yes Yes Yes No Yes -Sy*
--ask*
bash, fish batch interaction 1/2, fetch PGP keys

Graphical

Warning: Usage of graphical AUR helpers may lead to a defective system, for example through unattended partial upgrades.
  • Argon — GTK 3 pacman wrapper written in Python.
https://github.com/14mRh4X0r/arch-argon || argonAUR
  • Cylon — TUI pacman wrapper written in Bash.
https://github.com/gavinlyonsrepo/cylon || cylonAUR
  • Pamac — Standalone GTK 3 package manager using libalpm(3) written in Vala.
https://gitlab.manjaro.org/applications/pamac || pamac-aurAUR
  • Pakku GUI — GTK 3 frontend for pakku written in Python.
https://gitlab.com/mrvik/pakku-gui || pakku-guiAUR
  • PkgBrowser — Qt 5 read-only browser for repository packages and AUR written in Python.
https://bitbucket.org/kachelaqa/pkgbrowser || pkgbrowserAUR
  • Octopi — Qt 5 pacman wrapper written in C++.
https://octopiproject.wordpress.com/ || octopiAUR

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
  • aurpublish — Helper script to manage and upload AUR packages using git-subtree(1). Uses githooks(5) to verify the PKGBUILD integrity, generate .SRCINFO automatically, and create a commit message template.
https://github.com/eli-schwartz/aurpublish || aurpublish
https://git.archlinux.org/devtools.git/ || devtools
  • 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

Other

  • aur-talk — Fetch and display AUR comments.
https://github.com/GermainZ/aur-talk || aur-talk-gitAUR
  • aurvote-utils — A set of utilities for managing AUR votes.
https://github.com/jadenPete/aurvote-utils || aurvote-utilsAUR
  • haskell-aur — Haskell library for accessing Aurweb RPC interface.
https://hackage.haskell.org/package/aur || haskell-aurAUR
  • package-query — Tool for querying libalpm(3) and the AUR.
https://github.com/archlinuxfr/package-query || package-queryAUR
  • python3-aur — Python 3 modules and helper utilities for accessing AUR package information and automating AUR interactions.
https://xyne.archlinux.ca/projects/python3-aur || python3-aurAUR
https://gitlab.com/davidbittner/raur ||