View source for AUR helpers

[[Category:Package management]]
[[de:AUR Hilfsprogramme]]
[[es:AUR helpers]]
[[fr:Assistants AUR]]
[[ja:AUR ヘルパー]]
[[pt:AUR helpers]]
[[ru: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.}}

{{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]].

== 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 {{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 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}}.
* ''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>
* 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
|-
! {{AUR|aurman}}
| 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
|-
! {{AUR|aurutils}}
| 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
|-
! {{AUR|pakku}}
| 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
|-
! {{AUR|pikaur}}
| 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]
|-
! {{AUR|trizen}}
| 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
|-
! {{AUR|yay}}
| 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]
|-
! {{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 
|-
! {{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
|-
! {{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}}
| 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
|-
! {{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}}
| C || {{Yes}} || {{No}} [https://github.com/archlinuxfr/package-query/issues/135] || {{Grey|N/A}} || {{Grey|N/A}} || style="text-align:center;" | - || -
|-
! {{AUR|repoctl}}
| 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
|-
|}

=== 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
|-
|}

== 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}}}}

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