686d6a3188
Tweak readme, add install and contrib sections |
||
---|---|---|
.go | ||
completions | ||
doc | ||
testdata/keys | ||
vendor/github.com | ||
.gitignore | ||
callbacks.go | ||
clean.go | ||
cmd.go | ||
completions.go | ||
config.go | ||
conflicts.go | ||
dependencies.go | ||
download.go | ||
Gopkg.lock | ||
Gopkg.toml | ||
install.go | ||
ISSUE_TEMPLATE.md | ||
keys_test.go | ||
keys.go | ||
LICENSE | ||
main.go | ||
Makefile | ||
parser_test.go | ||
parser.go | ||
print_test.go | ||
print.go | ||
query_test.go | ||
query.go | ||
README.md | ||
upgrade_test.go | ||
upgrade.go | ||
utils.go | ||
vcs_test.go | ||
vcs.go |
yay
Yet another Yogurt - An AUR Helper written in Go
Packages
There's a point in everyone's life when you feel the need to write an AUR helper because there are only about 20 of them.
So say hi to 20+1.
Yay was created with a few objectives in mind and based on the design of yaourt, apacman and pacaur:
- Have almost no dependencies.
- Provide an interface for pacman.
- Have yaourt like search.
- Minimize user input
- Know when git packages are due for an upgrade.
Features
- AUR Tab completion
- Download PKGBUILD from ABS or AUR
- Ask all questions first and then start building
- Search narrowing (
yay linux header
will first search linux and then narrow on header) - No sourcing of PKGBUILD is done
- The binary has no dependencies that pacman doesn't already have.
- Advanced dependency solving
- Remove make dependencies at the end of the build process
Installation
If you are migrating from another AUR helper you can simply install Yay from the AUR like any other package.
The initial installation of Yay can be done by cloning the PKGBUILD and building with makepkg.
git clone https://aur.archlinux.org/yay.git
cd yay
makepkg -si
Contributing
Contributors are always welcome!
If you plan to make any large changes or changes that may not be 100% agreed on, we suggest opening an issue detailing your ideas first.
Otherwise send us a pull request and we will be happy to review it.
Code Style
All code should be formated through go fmt
. This tool will automatically
format code for you. Although it is recommended you write code in this style
and just use this tool to catch mistakes.
Building
Yay is easy to build with its only build dependency being go
and the
assumption of base-devel
being installed.
Run make
to build Yay. This will generate a binary called yay
in the same
directory as the Makefile.
Run make test
to test Yay. This will check the code is formatted correctly,
run the code through go vet
and run unit tests.
Yay's Makefile automaticly sets the GOPATH
to $PWD/.go
. This makes it easy to
build using the dependencies in vendor/
. Running manual go commands such as
go build
will require that you to either set the GOPATH
manually or go get
The dependencies into your own GOPATH
.
Vendored Dependencies
Yay depends on a couple of other projects. These are stored in vendor/
and
are built into Yay at build time. They do not need to be installed seperatly.
Currently yay Depends on:
- https://github.com/Jguer/go-alpm
- https://github.com/mikkeloscar/gopkgbuild
- https://github.com/mikkeloscar/aur
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
#123
Examples of Custom Operations
yay <Search Term>
presents package selection menuyay -Ps
prints system statisticsyay -Pu
prints update listyay -Yc
cleans unneeded dependenciesyay -G
downloads PKGBUILD from ABS or AURyay -Y --gendb
generates development package DB used for devel updates.yay -Syu --devel --timeupdate
Normal update but also check for development package updates and uses PKGBUILD modification time and not version to determine update