Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gamemaker1/yeet

A minimalistic pacman wrapper written in bash
https://github.com/gamemaker1/yeet

arch arch-linux arch-linux-aur arch-linux-packages arch-linux-pacman arch-linux-pkg aur-helper pacman yeet

Last synced: 13 days ago
JSON representation

A minimalistic pacman wrapper written in bash

Awesome Lists containing this project

README

        




yeet

> a beautiful, easy-to-use aur helper and pacman wrapper, inspired by
> [several](https://aur.archlinux.org/pikaur)
> [amazing](https://aur.archlinux.org/pacaur)
> [projects](https://aur.archlinux.org/paru).

## installation

### aur

If you already have an
[`aur` helper](https://wiki.archlinux.org/title/aur_helpers) installed, you can
install `yeet` from [`aur`](https://aur/archlinux.org/packages/yeet).

### install script

The script will perform the steps given in the
[manual installation section](#manual) for you. run the following in your
terminal:

```bash
> curl -sL https://raw.github.com/gamemaker1/yeet/develop/assets/package/install | bash
```

### manual

performing a manual installation requires the following packages:

- [`git`](https://aur.archlinux.org/git)
- [`base-devel`](https://aur.archlinux.org/base-devel)

to perform the installation, run the following in your terminal:

```
> git clone \
--depth=1 --branch=stable \
https://github.com/gamemaker1/yeet.git yeet
> cd yeet && make install
```

## usage

`yeet` aims to be a beautiful, easy to use, and minimal aur helper + pacman
wrapper. it:

- can search for a package; and then install it (`yeet `)
- can install a package from aur or the official repos
(`yeet -S `)
- allows you to edit build files before installing an aur package (default file
manager is `ranger`; this can be changed)
- can build an aur package using its pkgbuild (`yeet -B `)
- can remove a package and any unneeded dependencies (`yeet -R `)
- can upgrade all packages (`yeet -U`)
- allows you to run common `pacman` operations
(`yeet - [more pacman-specific options]`)
- can be configured easily - either through environment variables; or a config
file. an example configuration is stored at
`/usr/share/yeet/yeet.example.conf` once installed, and can be viewed
[on-line](./assets/package/yeet.example.conf).

## contributing

thank you for your interest in contributing to `yeet`!

you can contribute to `yeet` by spreading the word, spotting and fixing bugs,
and help adding new features. `yeet` is just a bash script, you may edit
[the file](./source/yeet) and submit a pull request. suggestions and pull
requests are welcome!

## license

this program and its associated files are all licensed under the gnu gpl v3
license. for more information, see [`license.md`](./license.md).