Difference between revisions of "AUR helpers"

From ArchWiki
Jump to: navigation, search
(Fetch only: move package-query to Pacman/Tips and tricks#Utilities)
(merge query-only helpers)
(4 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
[[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. 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]].}}
 
{{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.
+
AUR helpers automate certain tasks for using the [[Arch User Repository]]. Most helpers are designed to search for packages in AUR and fetch their [[PKGBUILD]]s, some additionally automate build and install process.
  
Since AUR helpers are unsupported, they are not present in the [[official repositories]].
+
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.
 +
 
 +
{{Warning|1=AUR contains user produced content, therefore AUR helpers that have fetch functionality are [https://bbs.archlinux.org/viewtopic.php?pid=828310#p828310 forbidden] for inclusion in [[official repositories]]. You should become familiar with the [[Arch User Repository#Installing packages|manual build process]] first in order to be prepared to troubleshoot problems.}}
  
 
== Legend ==
 
== Legend ==
Line 38: Line 39:
 
* 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.
 
* 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.}}
 
* ''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.}}
 +
 +
== Query only ==
 +
 +
{| class="wikitable sortable" style="text-align: center;"
 +
! Name !! Written in !! Reliable parser !! Specificity
 +
|-
 +
! {{AUR|package-query}}
 +
| C
 +
| {{R|[https://github.com/archlinuxfr/package-query/issues/135 No]}}
 +
| query pacman database and AUR
 +
|-
 +
! {{AUR|aarchup}}
 +
| C / GTK+ 2
 +
| {{Yes}}
 +
| update notifier
 +
|-
 +
! {{AUR|kalu}}
 +
| C / GTK+ 3
 +
| {{Yes}}
 +
| update notifier
 +
|-
 +
! {{AUR|pactray}}
 +
| Python / GTK+ 3
 +
| {{Yes}}
 +
| update notifier
 +
|-
 +
! {{AUR|pkgbrowser}}
 +
| Python / Qt 5
 +
| {{Yes}}
 +
| browser for pacman database and AUR
 +
|-
 +
! {{AUR|updatehint}}
 +
| Bash / GTK+ 3
 +
| {{Yes}}
 +
| update notifier
 +
|}
  
 
== Fetch only ==
 
== Fetch only ==
Line 142: Line 179:
  
 
{| class="wikitable sortable" style="text-align: center;"
 
{| class="wikitable sortable" style="text-align: center;"
! Name !! Written in !! GUI toolkit !! Backend helper !! Notes
+
! Name !! Written in !! GUI toolkit !! Backend helper !! Specificity !! Notes
|-
 
! {{AUR|aarchup}}
 
| C
 
| GTK+ 2
 
| auracle
 
| {{-}}
 
 
|-
 
|-
 
! {{AUR|argon}}
 
! {{AUR|argon}}
Line 154: Line 185:
 
| GTK+ 3
 
| GTK+ 3
 
| auracle, pacaur
 
| auracle, pacaur
 +
| package manager, update notifier
 
| {{-}}
 
| {{-}}
 
|-
 
|-
Line 160: Line 192:
 
| TUI
 
| TUI
 
| auracle, trizen
 
| auracle, trizen
 +
| package manager, update notifier
 
| {{-}}
 
| {{-}}
 
|-
 
|-
! {{AUR|kalu}}
 
| C
 
| GTK+ 3
 
| {{-}}
 
| {{-}}
 
|-
 
! {{AUR|pactray}}
 
| Python
 
| GTK+3
 
| auracle
 
| {{-}}
 
 
|-
 
|-
 
! {{AUR|pamac-aur}}
 
! {{AUR|pamac-aur}}
Line 178: Line 200:
 
| GTK+ 3
 
| GTK+ 3
 
| {{-}}
 
| {{-}}
| Uses {{man|3|libalpm}} instead of {{man|8|pacman}}
+
| package manager, update notifier
 +
| uses {{man|3|libalpm}} directly instead of wrapping {{man|8|pacman}}
 
|-
 
|-
 
! {{AUR|pakku-gui}}
 
! {{AUR|pakku-gui}}
Line 184: Line 207:
 
| GTK+ 3
 
| GTK+ 3
 
| pakku
 
| pakku
| {{-}}
+
| package manager
|-
 
! {{AUR|pkgbrowser}}
 
| Python
 
| Qt 5
 
| {{-}}
 
| {{-}}
 
|-
 
! {{AUR|updatehint}}
 
| Bash
 
| GTK+ 3
 
| auracle
 
 
| {{-}}
 
| {{-}}
 
|-
 
|-
Line 202: Line 214:
 
| Qt 5
 
| Qt 5
 
| trizen, pacaur, yaourt
 
| trizen, pacaur, yaourt
 +
| package manager, update notifier
 
| {{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]}}
 
| {{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]}}
 
|}
 
|}

Revision as of 16:15, 13 September 2018

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 are designed to search for packages in AUR and fetch their PKGBUILDs, some additionally automate build and install process.

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.

Warning: AUR contains user produced content, therefore AUR helpers that have fetch functionality are forbidden for inclusion in official repositories. You should become familiar with the manual build process first in order to be prepared to troubleshoot problems.

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

Query only

Name Written in Reliable parser Specificity
package-queryAUR C No query pacman database and AUR
aarchupAUR C / GTK+ 2 Yes update notifier
kaluAUR C / GTK+ 3 Yes update notifier
pactrayAUR Python / GTK+ 3 Yes update notifier
pkgbrowserAUR Python / Qt 5 Yes browser for pacman database and AUR
updatehintAUR Bash / GTK+ 3 Yes update notifier

Fetch 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
repoctlAUR Go Yes No Yes zsh local repository support
aurelAUR
(discontinued)
Emacs Lisp Yes No Yes Emacs integration

Fetch and build

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
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
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
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
(low activity)
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 Specificity Notes
argonAUR Python GTK+ 3 auracle, pacaur package manager, update notifier
cylonAUR Bash TUI auracle, trizen package manager, update notifier
pamac-aurAUR Vala GTK+ 3 package manager, update notifier uses libalpm(3) directly instead of wrapping pacman(8)
pakku-guiAUR Python GTK+ 3 pakku package manager
octopiAUR C++ Qt 5 trizen, pacaur, yaourt package manager, update notifier 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