github-actions[bot]andJo Garnier
45964c4b42
* fix(diff): add --no-pager and package header to git diff Previously, each package's diff was shown via a separate `git diff` invocation with Show(), allowing git to invoke its own pager (e.g. less) independently for each package. This caused inconsistent pagination: large diffs opened a pager, small diffs scrolled past in the terminal. Changes: - Add --no-pager flag to git diff so git doesn't open its own pager per package; all diffs now stream consistently to stdout. - Print a package name header before each diff so users can easily identify which package each diff belongs to when reviewing multiple packages. Closes #1243 * bunch up diffs and render in one go Co-authored-by: Jo Garnier <me@jguer.space>
190 lines
8.7 KiB
Markdown
190 lines
8.7 KiB
Markdown
[](https://aur.archlinux.org/packages/yay/)
|
|
[](https://aur.archlinux.org/packages/yay-bin/)
|
|
[](https://aur.archlinux.org/packages/yay-git/)
|
|
|
|
[](https://github.com/Jguer/yay/blob/next/LICENSE)
|
|
|
|
# yay
|
|
|
|
Yet Another Yogurt - An AUR Helper Written in Go
|
|
|
|
### Help translate yay: [Transifex](https://app.transifex.com/yay-1/yay/)
|
|
|
|
## Features
|
|
|
|
- Advanced dependency solving
|
|
- PKGBUILD downloading from ABS or AUR
|
|
- Completions for AUR packages
|
|
- Query user up-front for all input (prior to starting builds)
|
|
- Narrow search (`yay linux header` will first search `linux` and then narrow on `header`)
|
|
- Find matching package providers during search and allow selection
|
|
- Remove make dependencies at the end of the build process
|
|
- Build local PKGBUILDs with AUR dependencies
|
|
- Un/Vote for packages
|
|
|
|
[](https://asciinema.org/a/399431)
|
|
|
|
[](https://asciinema.org/a/399433)
|
|
|
|
## Installation
|
|
|
|
If you are migrating from another AUR helper, you can simply install yay with that helper.
|
|
|
|
> [!WARNING]
|
|
> We are using `sudo` in these examples. You can switch that out for a different privilege escalation tool.
|
|
|
|
### Source
|
|
|
|
The initial installation of yay can be done by cloning the PKGBUILD and
|
|
building with makepkg:
|
|
|
|
We make sure we have the `base-devel` package group installed.
|
|
|
|
```sh
|
|
sudo pacman -S --needed git base-devel
|
|
git clone https://aur.archlinux.org/yay.git
|
|
cd yay
|
|
makepkg -si
|
|
```
|
|
|
|
If you want to do all of this at once, we can chain the commands like so:
|
|
|
|
```sh
|
|
sudo pacman -S --needed git base-devel && git clone https://aur.archlinux.org/yay.git && cd yay && makepkg -si
|
|
```
|
|
|
|
### Binary
|
|
|
|
If you do not want to compile yay yourself you can use the builds generated by
|
|
GitHub Actions.
|
|
|
|
```sh
|
|
sudo pacman -S --needed git base-devel
|
|
git clone https://aur.archlinux.org/yay-bin.git
|
|
cd yay-bin
|
|
makepkg -si
|
|
```
|
|
|
|
If you want to do all of this at once, we can chain the commands like so:
|
|
|
|
```sh
|
|
sudo pacman -S --needed git base-devel && git clone https://aur.archlinux.org/yay-bin.git && cd yay-bin && makepkg -si
|
|
```
|
|
|
|
### Other distributions
|
|
|
|
If you're using Manjaro or [another distribution that packages `yay`](https://repology.org/project/yay/versions)
|
|
you can simply install yay using pacman (as root):
|
|
|
|
```sh
|
|
pacman -S --needed git base-devel yay
|
|
```
|
|
> [!WARNING]
|
|
> distributions sometimes lag updating yay on their repositories.
|
|
|
|
## First Use
|
|
|
|
#### Development packages upgrade
|
|
|
|
- Use `yay -Y --gendb` to generate a development package database for `*-git`
|
|
packages that were installed without yay.
|
|
This command should only be run once.
|
|
|
|
- `yay -Syu --devel` will then check for development package updates
|
|
|
|
- Use `yay -Y --devel --save` to make development package updates permanently
|
|
enabled (`yay` and `yay -Syu` will then always check dev packages)
|
|
|
|
## Examples of Custom Operations
|
|
|
|
| Command | Description |
|
|
| --------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
| `yay` | Alias to `yay -Syu`. |
|
|
| `yay <Search Term>` | Present package-installation selection menu. |
|
|
| `yay -Bi <dir>` | Install dependencies and build a local PKGBUILD. |
|
|
| `yay -G <AUR Package>` | Download PKGBUILD from ABS or AUR. (yay v12.0+) |
|
|
| `yay -Gp <AUR Package>` | Print to stdout PKGBUILD from ABS or AUR. |
|
|
| `yay -Ps` | Print system statistics. |
|
|
| `yay -Syu --devel` | Perform system upgrade, but also check for development package updates. |
|
|
| `yay -Wu <AUR Package>` | Unvote for package (Requires setting `AUR_USERNAME` and `AUR_PASSWORD` environment variables) (yay v11.3+) |
|
|
| `yay -Wv <AUR Package>` | Vote for package (Requires setting `AUR_USERNAME` and `AUR_PASSWORD` environment variables). (yay v11.3+) |
|
|
| `yay -Y --combinedupgrade --save` | Make combined upgrade the default mode. |
|
|
| `yay -Y --gendb` | Generate development package database used for devel update. |
|
|
| `yay -Yc` | Clean unneeded dependencies. |
|
|
|
|
## Frequently Asked Questions
|
|
|
|
- **yay does not display colored output. How do I fix it?**
|
|
|
|
Make sure you have the `Color` option in your `/etc/pacman.conf`
|
|
(see issue [#123](https://github.com/Jguer/yay/issues/123)).
|
|
|
|
- **How do I change the pager used for PKGBUILD diffs?**
|
|
|
|
Diffs for all selected packages are collected and shown in a single pager
|
|
session. Set `pager` in `config.json` or `yay.opt.pager` in `init.lua`, or
|
|
set `PAGER` to override the default (`less`, or `cat` if less is unavailable).
|
|
Example: `yay.opt.pager = "delta"` or `export PAGER=less`.
|
|
|
|
- **yay is not asking me to edit PKGBUILDS, and I don't like the diff menu! What can I do?**
|
|
|
|
`yay --editmenu --diffmenu=false --save`
|
|
|
|
- **How can I tell yay to act only on AUR packages, or only on repo packages?**
|
|
|
|
`yay -{OPERATION} --aur`
|
|
`yay -{OPERATION} --repo`
|
|
|
|
- **A `Flagged Out Of Date AUR Packages` message is displayed. Why doesn't yay update them?**
|
|
|
|
This message does not mean that updated AUR packages are available. It means
|
|
the packages have been flagged out of date on the AUR, but
|
|
their maintainers have not yet updated the `PKGBUILD`s
|
|
(see [outdated AUR packages](https://wiki.archlinux.org/index.php/Arch_User_Repository#Foo_in_the_AUR_is_outdated.3B_what_should_I_do.3F)).
|
|
|
|
- **yay doesn't install dependencies added to a PKGBUILD during installation.**
|
|
|
|
yay resolves all dependencies ahead of time. You are free to edit the
|
|
PKGBUILD in any way, but any problems you cause are your own and should not be
|
|
reported unless they can be reproduced with the original PKGBUILD.
|
|
|
|
- **I know my `-git` package has updates but yay doesn't offer to update it**
|
|
|
|
yay uses a hash cache for development packages. Normally it is updated at the end of the package install with the message `Found git repo`.
|
|
If you transition between aur helpers and did not install the devel package using yay at some point, it is possible it never got added to the cache. `yay -Y --gendb` will fix the current version of every devel package and start checking from there.
|
|
|
|
- **I want to help out!**
|
|
|
|
Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
|
|
|
|
## Support
|
|
|
|
All support related to yay should be requested via GitHub issues. Since yay is not
|
|
officially supported by Arch Linux, support should not be sought out on the
|
|
forums, AUR comments or other official channels.
|
|
|
|
A broken AUR package should be reported as a comment on the package's AUR page.
|
|
A package may only be considered broken if it fails to build with makepkg.
|
|
|
|
Reports should be made using makepkg and include the full output as well as any
|
|
other relevant information. Never make reports using yay or any other external
|
|
tools.
|
|
|
|
## Images
|
|
|
|
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/Jguer/jguer.github.io/refs/heads/master/yay/yay.png" width="42%">
|
|
<img src="https://raw.githubusercontent.com/Jguer/jguer.github.io/refs/heads/master/yay/yay-s.png" width="42%">
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/Jguer/jguer.github.io/refs/heads/master/yay/yay-y.png" width="42%">
|
|
<img src="https://raw.githubusercontent.com/Jguer/jguer.github.io/refs/heads/master/yay/yay-ps.png" width="42%">
|
|
</p>
|
|
|
|
### Other AUR helpers/tools
|
|
|
|
- [paru](https://github.com/morganamilo/paru)
|
|
- [aurutils](https://github.com/AladW/aurutils)
|
|
- [pikaur](https://github.com/actionless/pikaur)
|