Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documention: Update readme links and clarify binary installation #80

Merged
merged 1 commit into from
Mar 7, 2025
Merged

Documention: Update readme links and clarify binary installation #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# yaylog

`yaylog` is a CLI util, written in **Go** / **Golang**, for arch and arch-based linux distros to sort/filter installed packages.
`yaylog` is a CLI util, written in **Go** / **Golang**, for (arch linux)[https://archlinux.org] and arch-based linux distros to sort/filter installed packages.

despite the name, it's not limited to `yay` and works with any package manager that uses ALPM; so it can be used with `pacman`, `yay`, `paru`, `aura`, `pamac`, and even `yaourt` if you're somehow still using it.

`yaylog` supports optional filters/sorting for install date, package name, install reason (explicit/dependency), and size on disk.
`yaylog` supports optional filters/sorting for install date, package name, install reason (explicit/dependency), size on disk, reverse dependencies, dependency requirements, and more. check [usage](#usage) for all available options.

[![Packaging status](https://repology.org/badge/vertical-allrepos/yaylog.svg)](https://repology.org/project/yaylog/versions) ![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/Zweih/yaylog/total?style=for-the-badge&logo=archlinux&label=Downloads%20Since%202%2F4%2F2025&color=%20%231793d0)

![Alt](https://repobeats.axiom.co/api/embed/7a20b73b689d45d678001c582a9d1f124dca31ba.svg "Repobeats analytics image")


this package is compatible with the following distributions:
- arch linux
- manjaro
- steamOS
- garuda linux
- endeavourOS
- artix linux
- [arch linux](https://archlinux.org)
- [manjaro](https://manjaro.org/)
- [steamOS](https://store.steampowered.com/steamos)
- [garuda linux](https://garudalinux.org/)
- [endeavourOS](https://endeavouros.com/)
- [artix linux](https://artixlinux.org/)
- the 50 other arch-based distros, as long as it has pacman installed

## features
Expand Down Expand Up @@ -77,16 +77,19 @@ because yay is my preferred AUR helper and the name has a good flow.
- [x] required-by filter
- [ ] key/value output
- [ ] list of packages in required-by filter
- [ ] config dependency injection for testing

## installation

### from AUR (**recommended**)
install the binary using an AUR helper like `yay`:
install using [AUR helper](https://wiki.archlinux.org/title/AUR_helpers) like `yay`:
```bash
yay -S yaylog-bin
yay -S yaylog
```

if you prefer to install from source using the AUR, use the `yaylog` package instead.
if you prefer to install a pre-compiled binary* using the AUR, use the `yaylog-bin` package instead.

***note**: binaries are automatically, securely, and transparently compiled with github CI when a version release is created. you can audit the binary creation by checking the relevant github action for each release version.

for the latest (unstable) version from git w/ the AUR, use `yaylog-git`*.

Expand Down