pkm 1.1.0
Simple Yay wrapper
To use this package, run the following command in your project's root directory:
Manual usage
Put the following dependency into your project's dependences section:
pkm
PacKageManager - Simple apt-style yay wrapper
Description
pkm is simple AUR helper intended to be used alongside with yay. It is not trying to be full replacement, but tries to improve and streamline installation/discovery sprocess.
All pkm commands are simply yay commands, wrapped in apt/pamac ux, which are displayed as is except search. Search in pkm is tweaked to have minimal interface and provide better results sorting.
Installation
1. Install yay and follow yay first use
2.1 Source
Compilation of this repository requires dlang.
- Clone this repo and build it with
dub build -b release
. - Copy created binary
./bin/pkm
to somewhere in your path, for example~/.local/bin/
2.2 Binary
- Go to releases and download binary.
- Copy downloaded binary
./bin/pkm
to somewhere in your path, for example~/.local/bin/
2.3 AUR
Not implemented yet
2.4 dub
- Fetch package with
dub fetch pkm
- Run with
dub run pkm -b release -- [args...]
- Build and install into
/usr/bin
withdub build -b release -c install
Commands
pkm commands follow pamac/apt syntax. Installing pkm install package
, removing pkm remove package
, etc..
If you want to perform any of following command only on AUR then add --aur
or -a
flag to your command.
Command | Description | yay command | |
---|---|---|---|
search | Search for package. | yay -Ss [terms...] | |
list | List installed packages. | yay -Q | |
info | Print info about package. | yay -Qi [packages...] | |
install | Install package. | yay -S [packages...] | |
remove | Remove package. | yay -R [packages...] | |
checkupdates | Checks for available updates. | yay -Qu | |
update | Update repositories. | yay -Sy [packages...] | |
upgrade | Upgrade installed packages. | yay -Su [packages...] | |
clean | Clean unneeded dependencies. | yay -Yc | |
stats | Print system statistics. | yay -Ps | |
pkgbuild | Print PKGBUILD file | yay -Gp [packages...] |
Config
pkm can be configured with config file located at ~/.config/pkm/conf.yaml
or ~/.pkm.yaml
one at ~
takes prority.
Name | Type | Description | Default |
---|---|---|---|
yaypath | string | Custom path to yay binary. | Guessed with which |
yaysearch | bool | Disable custom pkm search. | false |
color | bool | Should search be printed in color. Will not work if yaysearch is true . | true |
auronly | bool | Should yay search only AUR. | false |
Example config:
# conf.yaml
yaypath: ~/.local/bin/yay
yaysearch: yes
auronly: yes
How to read search
All available pkm
commands are calling yay
with corresponding flags. This is true for search, but pkm also performs special operations to customise and improve yay's search.
Search always follows this schema:
package-name [a] [o] [i] version/installed-version package-size/votes install-size/popularity [repo]
description
Here's small table to assist you in reading it:
| Field | Meaning | Special notes |
| :- | :- | :- |
| package-name | Name of package. | |
| [a] | Is package orphaned. | Highlighted in red when true. If color is disabled displayed as [ ]. "A" stands for abandoned. |
| [o] | Is package outdated. | Highlighted in red when true. If color is disabled displayed as [ ]. |
| [i] | Is package installed. | Highlighted in green when true. If color is disabled displayed as [ ]. |
| version | Version of package. | If installed version is different from current verison then field shows installed version hightlighed in light magenta. If color is disabled version diff shown with @
at start. |
| package-size/votes | See notes. | If package from AUR: Package votes.
If package not from AUR: Package size.
| package-size/votes | See notes. | If package from AUR: Package popularity.
If package not from AUR: Installation size.
| [repo] | Repository of package. | Repository name is cropped to 3 symbols.
| description | Description. | |
If package is from AUR then it's displaying votes/popularity instead of size and votes/popularity are highlighted in this way:
Other AUR helpers/tools
- Registered by Alisa Lain
- 1.1.0 released 2 years ago
- al1-ce/pkm
- MIT License
- Copyright © 2022, Alisa Lain
- Authors:
- Dependencies:
- dyaml
- Versions:
-
1.2.1 2023-May-08 1.2.0 2022-Dec-08 1.1.5 2022-Dec-08 1.1.4 2022-Nov-26 1.1.3 2022-Nov-25 - Download Stats:
-
-
0 downloads today
-
0 downloads this week
-
0 downloads this month
-
27 downloads total
-
- Score:
- 0.0
- Short URL:
- pkm.dub.pm