fuzzy-pkg-finder/README.md

79 lines
2.6 KiB
Markdown
Raw Normal View History

2021-07-16 18:54:33 -05:00
<div align="right">
<img src="https://img.shields.io/static/v1?label=Language&message=shell&color=%235BB97E&style=flat-square"/>
<img src="https://img.shields.io/github/license/ericlay/fuzzy-pkg-finder?color=%235BB97E&label=LIC&style=flat-square"/>
</div>
<div align="center"><h1>📦<br>Fuzzy-pkg-finder</h1></div>
2020-06-11 15:17:17 -05:00
2020-06-28 23:17:39 -05:00
**Simple cli utility using fzf to search and install/list/remove packages.**\
2020-06-11 21:01:56 -05:00
\
2020-06-28 23:15:23 -05:00
![Screenshot](https://gitlab.com/airclay/fuzzy-pkg-finder/-/raw/master/fpf.png) \
2020-06-28 23:09:02 -05:00
\
2023-03-29 10:20:03 -05:00
Leverages the power of fzf to search package names and descriptions then presents complete package information in preview pane. \
2021-07-27 15:04:54 -05:00
On selection will hand off to Pacman or Paru/Yay to complete transaction. \
2020-06-12 16:29:23 -05:00
\
2021-07-27 14:18:36 -05:00
*For use with Pacman/Yay/Paru package managers only.*\
2020-06-12 16:24:15 -05:00
\
2023-11-19 15:11:37 -06:00
There are countless fzf package manager wrappers out there, some much more built out that this. \
\
What separates Fuzzy-pkg-finder? \
2023-11-19 15:06:15 -06:00
- It's mine and it works the way I like it to
- It works as a simple script to wrap pacman/yay/paru, no need to rebuild the wheel
- Searches both package names and descriptions for keyword
- Hide preview window to see only packages and descriptions
- Shows files list and/or missing files for official repo or installed AUR packages
2023-11-19 15:05:19 -06:00
- Toggle between package info view and PKGBUILD view on AUR package preview \
2023-11-19 15:03:22 -06:00
\
2021-07-27 14:18:36 -05:00
Installation: \
2021-07-27 15:04:54 -05:00
For Arch and arch-based distros, it is available in the AUR. \
Use: `paru -S fuzzy-pkg-finder` or `yay -S fuzzy-pkg-finder` \
2021-07-27 14:18:36 -05:00
\
2021-07-27 15:04:54 -05:00
Manual build and install:
2020-06-14 06:43:08 -05:00
```
2020-06-12 16:24:15 -05:00
git clone https://github.com/ericlay/fuzzy-pkg-finder
cd fuzzy-pkg-finder
2020-06-15 14:58:23 -05:00
makepkg -sric
2020-06-12 16:26:56 -05:00
```
2020-06-12 16:24:15 -05:00
\
2020-06-14 06:45:09 -05:00
Usage:
2020-06-14 06:43:08 -05:00
```
2023-03-29 10:20:03 -05:00
Syntax: fpf [-a| --aur] [-l| --list-installed] [-la| --list-aur-installed]
[R| --remove] [-o| --orphans] [-h | --help]
2020-06-14 06:43:08 -05:00
Defaults to Pacman if no options passed
2020-07-30 14:00:59 -05:00
Searching for a package:
ex: fpf [pkg name] for official repo search
ex: fpf -a [pkg name] for aur search
2023-03-29 10:20:03 -05:00
Options:
-a, --aur
Search/List and install from AUR with Yay
-l, --list-installed
Search/List installed packages from official repo
-la, --list-aur-installed
Search/List installed packages from AUR
-R, -remove
Search/List installed packages for removal
-o, --orphans
Search/List orphaned packages for removal
-h, --help
Print this help screen
2020-06-14 06:43:08 -05:00
```
\
Keybinds:
```
2023-11-19 13:13:20 -06:00
'ctrl + /' Toggle the preview window
'ctrl + h' Show help in the preview window
'ctrl + k' Show the keybinds in teh preview window
'ctrl + n' Move to the next selected item
'ctrl + b' Back to previoius selected item
When browsing AUR or installed Aur pkgs:
2023-11-19 13:13:20 -06:00
'ctrl + p' Preview the highlighted pkgbuild file
'ctrl + x' Return to the highlighted pkg info
```