Difference between revisions of "AUR helpers"

From ArchWiki
Jump to: navigation, search
(update example, moved to nikola)
(Pacman wrappers: "low activity" and "stalled" are really the same, and yaourt doesn't display significant more activity than either packer or wrapaur)
 
(402 intermediate revisions by 38 users not shown)
Line 1: Line 1:
 
[[Category:Package management]]
 
[[Category:Package management]]
 +
[[Category:Software comparisons]]
 
[[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. You should become familiar with the [[Arch User Repository#Installing packages|manual build process]] in order to be prepared to troubleshoot problems.}}
 +
{{Note|Do not edit this article prior to discussion in [[Talk:AUR helpers]].}}
  
AUR helpers are written to automate certain tasks for the [[Arch User Repository]].
+
AUR helpers automate certain tasks for using the [[Arch User Repository]]. Most helpers automate the process of retrieving a package's [[PKGBUILD]] from the AUR and building the package. In most cases packages installed from the AUR are not checked for updates by [[pacman]]; thus some helpers check the AUR for updates and automate the re-build process. However, keep in mind that a rebuild of an AUR package, or any other packages built and installed locally, may be required when shared libraries are updated, not just when the package is updated.
  
== Uploading ==
+
Since AUR helpers are unsupported, they are not present in the [[official repositories]].
  
* [https://gist.github.com/bbidulock/82ab6f5347f021136054 bbidulock's script] — Migrate from a .backup directory with all packages.
+
== Legend ==
* [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 ==
+
The columns have the following meaning:
  
This is a list of helper utilities that search, download and/or build packages.
+
;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'''. ''Optional'' means that there is a command line flag or configuration option to prevent the automatic sourcing before viewing.
 +
;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.
 +
;Git clone: Uses {{man|1|git-clone}} 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 [[w:Parsing#Parser|parsing]], such as {{AUR|aws-cli-git}}.
 +
;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:
 +
:* Multiple packages from the same package base, without rebuilding or reinstalling multiple times, such as {{AUR|clion}}
 +
:* 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}}.
 +
;Clean build: Does not export new variables that can prevent a successful build process.
 +
;Batch interaction: Ability to prompt before the build process, in particular:
 +
:# Inspection of package files or their differences;
 +
:# Summary of 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.
  
* {{App|apacman|A fork of packer.|https://github.com/oshazard/apacman|{{AUR|apacman}}}}
+
{{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.}}
  
* {{App|aura|A package manager for Arch Linux written in Haskell.|https://github.com/aurapm/aura|{{AUR|aura}} or {{AUR|aura-bin}} (binary)}}
+
== Search-only ==
  
* {{App|auracle|An AUR client written in C++.|https://github.com/falconindy/auracle|{{AUR|auracle-git}}}}
+
{| class="wikitable sortable" style="text-align: center;"
 +
! Name !! Written in !! File review !! Git clone !! Reliable parser !! Reliable solver !! Shell completion !! Specificity
 +
|-
 +
! {{AUR|pbget}}
 +
| Python || {{Yes}} || {{Yes}} || {{Yes}} || {{-}} || {{-}} || {{-}}
 +
|-
 +
! {{AUR|yaah}}
 +
| Bash || {{Yes}} || {{Y|Optional}} || {{Yes}} || {{-}} || bash || {{-}}
 +
|-
 +
! {{AUR|auracle-git}}
 +
| C++ || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{-}} || {{L|print build order}}
 +
|-
 +
! {{AUR|cower}}
 +
| C  || {{Yes}} || {{No}} || {{Yes}} || {{-}} || bash, zsh || {{L|regex support, sort by votes/popularity}}
 +
|-
 +
! {{AUR|package-query}}
 +
| C || {{Yes}} || {{-}} || {{No|https://github.com/archlinuxfr/package-query/issues/135}} || {{-}} || {{-}} || {{-}}
 +
|-
 +
! {{AUR|repoctl}}
 +
| Go || {{Yes}} || {{No}} || {{Yes|https://github.com/goulash/pacman/blob/master/aur/aur.go}} || {{-}} || zsh || {{L|local repository support}}
 +
|-
 +
! {{Grey|1={{AUR|aurel}} <br> <small>([https://bbs.archlinux.org/viewtopic.php?pid=1522459#p1522459 discontinued])</small>}}
 +
| Emacs Lisp || {{Yes}} || {{No}} || {{Yes}} || {{-}} || {{-}} || {{L|Emacs integration}}
 +
|}
  
* {{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
+
== Build and search ==
|4={{AUR|aurel-git}}}}
 
  
* {{App|aurget|pacman-like interface to the AUR, without wrapping pacman commands.|https://github.com/pbrisbin/aurget/|{{AUR|aurget}}}}
+
{| class="wikitable sortable" style="text-align: center;"
 +
! Name !! Written in !! File review !! Diff view !! Git clone !! Reliable parser !! Reliable solver !! Split packages !! Clean build !! Batch interaction || Shell completion !! Specificity
 +
|-
 +
! {{AUR|aurutils}}
 +
| Bash/C || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || 1 || zsh || {{L|[[vifm]], [[local repository]], [[package signing]], [[DeveloperWiki:Building_in_a_Clean_Chroot|clean chroot]] support, sort by votes/popularity}}
 +
|-
 +
! {{AUR|bauerbill}}
 +
| Python || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || 1 || bash, zsh || {{L|trust management, [[ABS]] support, extends ''powerpill'', {{ic|bb-wrapper}} for ''pacman'' wrapping}}
 +
|-
 +
! {{AUR|PKGBUILDer}}
 +
| Python || {{Y|Optional}} || {{No|https://github.com/Kwpolska/pkgbuilder/issues/36}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Y|[https://github.com/Kwpolska/pkgbuilder/issues/39 Partial]}} || {{Yes}} || 1* || {{-}} || {{L|automatic builds by default, use {{ic|-F}} to disable; multilingual, {{ic|pb-wrapper}} for ''pacman'' wrapping}}
 +
|-
 +
! {{AUR|naaman}}
 +
| Python || {{Y|Optional}} || {{No}} || {{Yes}} || {{Yes}} || {{Y|[https://github.com/enckse/naaman/issues/19 Partial]}} || {{Y|[https://github.com/enckse/naaman/issues/20 Partial]}} || {{Yes}} || 1* || bash || {{L|automatic builds by default, use {{ic|--fetch}} to disable; use {{ic|-d}} to enable the solver}}
 +
|-
 +
! {{AUR|repofish}}
 +
| Bash || {{Y|Optional}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{Yes}} || 1* || {{-}} || {{L|automatic builds by default, use {{ic|check}} or {{ic|update}} to disable; [[local repository]] support}}
 +
|-
 +
! {{AUR|aurget}}
 +
| Bash || {{Y|Optional}} || {{No|https://github.com/pbrisbin/aurget/issues/41}} || {{No}} || {{No}} || {{No}} || {{No|https://github.com/pbrisbin/aurget/issues/40}} || {{Yes}} || {{-}} || bash, zsh || {{L|sort by votes}}
 +
|-
 +
! {{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}} || {{Yes}} || {{-}} || {{-}} || {{-}}
 +
|-
 +
! {{Grey|{{AUR|burgaur}} <br> <small>([https://github.com/m45t3r/burgaur/issues/7#issuecomment-365599675 discontinued])</small>}}
 +
| Python/C || {{Y|Optional}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{-}} || {{-}} || {{L|wrapper for ''cower''}}
 +
|}
  
* {{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}}}}
+
== Pacman wrappers ==
  
* {{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}}}}
+
See also [[pacman/Tips and tricks#Pacman wrappers]].
  
* {{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}}}}
+
{{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.}}
 
* {{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}}}}
+
{| class="wikitable sortable" style="text-align: center;"
 
+
! Name !! Written in !! File review !! Diff view !! Git clone !! Reliable parser !! Reliable solver !! Split packages !! Clean build !! Unsafe flags !! Batch interaction !! Shell completion !! Specificity
*{{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:
 
 
 
* ''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.
 
* ''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}}.
 
* ''Split packages'': ability to correctly build and install split packages independently, such as {{AUR|nikola}}.
 
* ''Git clone'': uses git clones instead of downloading tarballs (deprecated since AUR 4).
 
* ''Syntax'': P stands for [[Pacman]]-like, S for specific.
 
 
 
{| class="wikitable sortable"
 
! Name !! Written In !! Secure !! Clean build !! Reliable parser !! Reliable solver !! Split packages !! Git clone !! Shell completion !! Syntax !! Specificity
 
 
|-
 
|-
! apacman
+
! {{AUR|pakku}}
| 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''
+
| Nim || {{Yes}} || {{Yes|https://github.com/kitsunyan/pakku/commit/396e9f4}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes|https://github.com/kitsunyan/pakku/commit/864cc03}} || [https://github.com/kitsunyan/pakku/wiki/Native-Pacman-Explanation {{ic|-Sy}}] || 1 || bash, zsh || {{L|[[ABS]] support, AUR comments, fetch PGP keys}}
 
|-
 
|-
! aura
+
! {{AUR|pikaur}}
| 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]]
+
| Python || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes|https://github.com/actionless/pikaur/commit/d409b95}} || {{Yes}} || [https://github.com/actionless/pikaur#pikaur {{ic|-Sy}}] || 1, 2, 3 || bash, fish, zsh || {{L|[http://0pointer.net/blog/dynamic-users-with-systemd.html dynamic users], [https://github.com/actionless/pikaur/tree/master/locale multilingual], sort by votes/popularity, print news, [https://github.com/actionless/pikaur/commit/3688d82 ignore errors]}}
 
|-
 
|-
! 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|https://github.com/Jguer/yay/pull/447}} || {{Yes|https://github.com/Jguer/yay/pull/297}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || [https://github.com/Jguer/yay/commit/3bdb534 {{ic|-Sy}}*]<br>[https://github.com/Jguer/yay/commit/ea5a94e {{ic|--ask}}*] || 1, [https://github.com/Jguer/yay/commit/3bdb534 2*], [https://github.com/Jguer/yay/commit/ea5a94e 3*] || bash, fish, zsh || {{L|fetch PGP keys, sort by votes/popularity, [https://github.com/Jguer/yay/commit/4bcd3a6 prompt architecture]}}
 
|-
 
|-
! aurel
+
! {{AUR|trizen}}
| 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
+
| 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]}} || {{Yes}} || {{Y|[https://github.com/trizen/trizen/commit/9e7b40e {{ic|-Ud}}*] || 1* || bash, fish, zsh || {{L|automatic builds by default, use {{ic|-G}} to disable; AUR comments}}
 
|-
 
|-
! aurget
+
! {{AUR|aura}}
| 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
+
| Haskell || {{Y|Optional}} || {{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}} || {{Yes}} || {{-}} || 1* || bash, zsh || {{L|automatic builds by default, use {{ic|--dryrun}} to disable; [[downgrade]] support, multilingual}}
 
|-
 
|-
! aurutils
+
! {{Grey|{{AUR|aurman}} <br> <small>([https://github.com/polygamma/aurman#stopped-development-for-public-use no&nbsp;user&nbsp;support])</small>}}
| 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
+
| Python || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes|https://github.com/polygamma/aurman/wiki/Description-of-the-aurman-dependency-solving}} || {{Yes}} || {{Yes}} || [https://github.com/polygamma/aurman/commit/6c02ba3 {{ic|-Sy}}*]<br>[https://github.com/polygamma/aurman#make-use-of-the-undocumented---ask-flag-of-pacman {{ic|--ask}}*] || 1, [https://github.com/polygamma/aurman#question-6 2*, 3*] || bash, fish || {{L|fetch PGP keys, sort by votes/popularity, print news}}
 
|-
 
|-
! bauerbill
+
! {{Grey|1={{AUR|pacaur}} <br> <small>([https://bbs.archlinux.org/viewtopic.php?pid=1755144#p1755144 discontinued])</small>}}
| 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
+
| Bash/C || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || [https://github.com/rmarquis/pacaur/commit/d8f4918 {{ic|-Ud}}]<br>[https://github.com/rmarquis/pacaur/commit/12707cc {{ic|--ask}}] || 1, 3 || bash, zsh || {{L|multilingual, sort by votes/popularity}}
 
|-
 
|-
! burgaur
+
! {{Grey|{{AUR|wrapaur}} <br> <small>(stalled)</small>}}
| Python/C || {{Y|Optional}}, with [[mc]] || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | None || style="text-align:center;" | P || Wrapper for ''cower''
+
| Bash || {{Yes}} || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{-}} || {{-}} || {{-}} || {{L|mirror updates, print news and AUR comments}}
 
|-
 
|-
! owlman
+
! {{Grey|{{AUR|packer-aur}} <br> <small>(stalled)</small>}}
| Bash/C || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Y|Partial}} || {{No}} || style="text-align:center;" | None || style="text-align:center;" | S || Wrapper for ''cower''
+
| Bash || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{-}} || {{-}} || {{-}} || {{-}}
 
|-
 
|-
! pacaur
+
! {{Grey|{{AUR|yaourt}} <br> <small>(stalled)</small>}}
| 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
+
| Bash/C || {{No|https://github.com/archlinuxfr/yaourt/blob/34b5c0b/src/lib/aur.sh#L54-L72}} || {{Y|Optional}} || {{Y|Optional}} || {{No}} || {{No|https://github.com/archlinuxfr/yaourt/issues/186}} || {{No|https://github.com/archlinuxfr/yaourt/issues/85}} || {{No|https://lists.archlinux.org/pipermail/aur-general/2015-August/031314.html}} || [https://github.com/archlinuxfr/yaourt/blob/d30823e/yaourt/yaourt#L1773 {{ic|-Sy}}] || 2 || bash, fish, zsh || {{L|ABS support, print AUR comments, multilingual}}
|-
+
|}
! packer
+
 
| Bash || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || style="text-align:center;" | None || style="text-align:center;" | P || -
+
== Graphical ==
|-
+
 
! pbget
+
See also [[pacman/Tips and tricks#Graphical front-ends]].
| 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
+
 
 +
{{Warning|
 +
* Graphical AUR helpers are typically aimed at [[Arch-based distributions]]. Their use in [[Arch Linux]] may lead to a defective system, for example through unattended [[partial upgrades]].
 +
* If a helper has ''known'' problematic behavior, it is colored with a red entry.}}
 +
 
 +
{| class="wikitable sortable" style="text-align: center;"
 +
! Name !! Written in !! GUI toolkit !! Backend helper !! Notes
 
|-
 
|-
! PKGBUILDer
+
! {{AUR|aarchup}}
| 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
+
| C
 +
| GTK+ 2
 +
| auracle
 +
| {{-}}
 
|-
 
|-
! prm
+
! {{AUR|argon}}
| 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
+
| Python
 +
| GTK+ 3
 +
| auracle, pacaur
 +
| {{-}}
 
|-
 
|-
! repoctl
+
! {{AUR|cylon}}
| 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
+
| Bash
 +
| TUI
 +
| auracle, trizen
 +
| {{-}}
 
|-
 
|-
! spinach
+
! {{AUR|kalu}}
| 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 || -
+
| C
 +
| GTK+ 3
 +
| {{-}}
 +
| {{-}}
 
|-
 
|-
! trizen
+
! {{AUR|pactray}}
| 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
+
| Python
 +
| GTK+3
 +
| auracle
 +
| {{-}}
 
|-
 
|-
! wrapaur
+
! {{AUR|pamac-aur}}
| Bash || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{Yes}} || style="text-align:center;" | None || style="text-align:center;" | S || Mirror updates, print news and AUR comments
+
| Vala
 +
| GTK+ 3
 +
| {{-}}
 +
| Uses {{man|3|libalpm}} instead of {{man|8|pacman}}
 
|-
 
|-
! yaah
+
! {{AUR|pakku-gui}}
| 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
+
| Python
 +
| GTK+ 3
 +
| pakku
 +
| {{-}}
 
|-
 
|-
! yaourt
+
! {{AUR|pkgbrowser}}
| 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
+
| Python
 +
| Qt 5
 +
| {{-}}
 +
| {{-}}
 
|-
 
|-
! yay
+
! {{AUR|updatehint}}
| Go || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Y|Partial}} || {{No}} || style="text-align:center;" | bash/zsh/fish || style="text-align:center;" | P || sort by votes
+
| Bash
 +
| GTK+ 3
 +
| auracle
 +
| {{-}}
 
|-
 
|-
 +
! {{R|{{AUR|octopi}}}}
 +
| C++
 +
| Qt 5
 +
| trizen, pacaur, yaourt
 +
| {{R|[https://github.com/aarnt/octopi/blob/271c7e1/octopi.install enabled on install] notifier service regularly [https://github.com/aarnt/octopi/issues/134#issuecomment-142099266 performs partial upgrades]}}
 
|}
 
|}
  
{{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}}
 +
* {{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}}}}

Latest revision as of 10:13, 21 September 2018

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: Do not edit this article prior to discussion in Talk:AUR helpers.

AUR helpers automate certain tasks for using the Arch User Repository. Most helpers automate the process of retrieving a package's PKGBUILD from the AUR and building the package. In most cases packages installed from the AUR are not checked for updates by pacman; thus some helpers check the AUR for updates and automate the re-build process. However, keep in mind that a rebuild of an AUR package, or any other packages built and installed locally, may be required when shared libraries are updated, not just when the package is updated.

Since AUR helpers are unsupported, they are not present in the official repositories.

Legend

The 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. Optional means that there is a command line flag or configuration option to prevent the automatic sourcing before viewing.
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.
Clean build
Does not export new variables that can prevent a successful build process.
Batch interaction
Ability to prompt before the build process, in particular:
  1. Inspection of package files or their differences;
  2. Summary of package upgrades;
  3. Resolution of package conflicts and installations.
An asterisk denotes functionality specifically enabled by the user.
Shell completion
Tab completion is available for the listed shells.
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.

Search-only

Name Written in File review Git clone Reliable parser Reliable solver Shell completion Specificity
pbgetAUR Python Yes Yes Yes
yaahAUR Bash Yes Optional Yes bash
auracle-gitAUR C++ Yes No Yes Yes print build order
cowerAUR C Yes No Yes bash, zsh regex support, sort by votes/popularity
package-queryAUR C Yes No
repoctlAUR Go Yes No Yes zsh local repository support
aurelAUR
(discontinued)
Emacs Lisp Yes No Yes Emacs integration

Build and search

Name Written in File review Diff view Git clone Reliable parser Reliable solver Split packages Clean build Batch interaction Shell completion Specificity
aurutilsAUR Bash/C Yes Yes Yes Yes Yes Yes Yes 1 zsh vifm, local repository, package signing, clean chroot support, sort by votes/popularity
bauerbillAUR Python Yes No Yes Yes Yes Yes Yes 1 bash, zsh trust management, ABS support, extends powerpill, bb-wrapper for pacman wrapping
PKGBUILDerAUR Python Optional No Yes Yes Yes Partial Yes 1* automatic builds by default, use -F to disable; multilingual, pb-wrapper for pacman wrapping
naamanAUR Python Optional No Yes Yes Partial Partial Yes 1* bash automatic builds by default, use --fetch to disable; use -d to enable the solver
repofishAUR Bash Optional Yes Yes No No No Yes 1* automatic builds by default, use check or update to disable; local repository support
aurgetAUR Bash Optional No No No No No Yes bash, zsh sort by votes
spinachAUR
(discontinued)
Bash Yes No No No No No Yes
burgaurAUR
(discontinued)
Python/C Optional No No No No No Yes wrapper for cower

Pacman wrappers

See also pacman/Tips and tricks#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 Clean build Unsafe flags Batch interaction Shell completion Specificity
pakkuAUR Nim Yes Yes Yes Yes Yes Yes Yes -Sy 1 bash, zsh ABS support, AUR comments, fetch PGP keys
pikaurAUR Python Yes Yes Yes Yes Yes Yes Yes -Sy 1, 2, 3 bash, fish, zsh dynamic users, multilingual, sort by votes/popularity, print news, ignore errors
yayAUR Go Yes Yes Yes Yes Yes Yes Yes -Sy*
--ask*
1, 2*, 3* bash, fish, zsh fetch PGP keys, sort by votes/popularity, prompt architecture
trizenAUR Perl Yes Yes Yes Yes Yes Partial Yes -Ud* 1* bash, fish, zsh automatic builds by default, use -G to disable; AUR comments
auraAUR Haskell Optional Partial No Yes No No Yes 1* bash, zsh automatic builds by default, use --dryrun to disable; downgrade support, multilingual
aurmanAUR
(no user support)
Python Yes Yes Yes Yes Yes Yes Yes -Sy*
--ask*
1, 2*, 3* bash, fish fetch PGP keys, sort by votes/popularity, print news
pacaurAUR
(discontinued)
Bash/C Yes Yes Yes Yes Yes Yes Yes -Ud
--ask
1, 3 bash, zsh multilingual, sort by votes/popularity
wrapaurAUR
(stalled)
Bash Yes No Yes No No No Yes mirror updates, print news and AUR comments
packer-aurAUR
(stalled)
Bash No No No No No No Yes
yaourtAUR
(stalled)
Bash/C No Optional Optional No No No No -Sy 2 bash, fish, zsh ABS support, print AUR comments, multilingual

Graphical

See also pacman/Tips and tricks#Graphical front-ends.

Warning:
  • Graphical AUR helpers are typically aimed at Arch-based distributions. Their use in Arch Linux may lead to a defective system, for example through unattended partial upgrades.
  • If a helper has known problematic behavior, it is colored with a red entry.
Name Written in GUI toolkit Backend helper Notes
aarchupAUR C GTK+ 2 auracle
argonAUR Python GTK+ 3 auracle, pacaur
cylonAUR Bash TUI auracle, trizen
kaluAUR C GTK+ 3
pactrayAUR Python GTK+3 auracle
pamac-aurAUR Vala GTK+ 3 Uses libalpm(3) instead of pacman(8)
pakku-guiAUR Python GTK+ 3 pakku
pkgbrowserAUR Python Qt 5
updatehintAUR Bash GTK+ 3 auracle
octopiAUR C++ Qt 5 trizen, pacaur, yaourt enabled on install notifier service regularly performs partial upgrades

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 — 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