auracle

Display AUR packages that match a regex

$ auracle search '[regex]'

$ auracle info [package1 package2 ...]

$ auracle show [package1 package2 ...]

$ auracle outdated

auracle [options] [arguments...]

-h, --help
    Display help information for auracle or a specific subcommand.

-q, --quiet
    Suppress verbose output, useful for scripting.

-j, --json
    Output results in JSON format.

-r, --repo
    Query official Arch repositories instead of the AUR.

-L , --limit
    Limit the number of results returned.

-f , --format
    Specify a custom output format for results.

--color
    Control colored output (auto, always, never).

--version
    Show auracle version information.

search
    Search for packages on the AUR or official repositories.
Options: -s (startswith), -E (exact), -v (vote).

info
    Display detailed information about one or more AUR packages.

download
    Download PKGBUILDs and associated files for specified packages.
Options: -d (directory), -a (all dependencies), -c (clean).

clone
    Clone the Git repository containing PKGBUILDs for specified packages.

udiff
    Show a unified diff between local and remote PKGBUILDs.

outdated [packages...]
    List installed AUR packages that are outdated according to the AUR.

orphaned
    List installed AUR packages that are orphaned on the AUR.

sync
    Synchronize local PKGBUILDs with the remote versions.

raw
    Query the raw AUR API endpoint at the specified path.

auracle is a command-line utility written in C++ designed to interact with the Arch User Repository (AUR). Unlike full-fledged AUR helpers that build and install packages, auracle focuses primarily on querying, searching, and downloading PKGBUILDs and their related files efficiently. It provides a clean, programmatic interface, making it an excellent backend tool for other AUR helpers or for users who prefer to manually manage their AUR packages after fetching them. Its design prioritizes speed and reliability, offering various subcommands to search for packages, retrieve detailed information, download source files, or even clone Git repositories containing PKGBUILDs. It supports JSON output for easy parsing in scripts and offers options for filtering and customizing search results.

auracle itself does not build or install packages. It is solely a query and download tool. Users are expected to use makepkg(8) and pacman(8) to build and install downloaded packages. For a fully automated experience, consider using a dedicated AUR helper that utilizes auracle as a backend.

Many modern AUR helpers, such as yay and paru, utilize auracle internally for querying AUR data due to its speed and JSON output capabilities. While auracle can be used directly, its primary strength lies in providing a foundational layer for more complex AUR management tools.

When downloading PKGBUILDs using auracle, it's crucial to inspect them before building. AUR packages are user-contributed and not officially sanctioned by Arch Linux. Always review the PKGBUILD and any included .install files for malicious or unintended actions before proceeding with makepkg(8) and pacman(8).

auracle was developed as a modern, fast, and robust C++ client for the Arch User Repository. Its creation was motivated by a desire for a reliable, low-level building block that AUR helpers could leverage, offering better performance and more structured output than older shell-script based solutions or parsing of AUR web pages. It provides a stable API for programmatic interaction, making it ideal for integration into other tools.

pacman(8), makepkg(8), git(1), yay(8), paru(8)