You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
amethyst/README.md

56 lines
2.0 KiB
Markdown

3 years ago
<p align="center">
<a href="https://github.com/crystal-linux">
3 years ago
<img src="https://git.getcryst.al/crystal/branding/raw/branch/main/logos/crystal-logo-minimal.png" alt="Logo" width="150" height="150">
3 years ago
</a>
</p>
<p align="center">
3 years ago
<h2 align="center"> Amethyst</h2>
3 years ago
</p>
<p align="center">
<img src=https://img.shields.io/github/stars/crystal-linux/ame?style=flat&color=a900ff&logo=Github />
<img src=https://img.shields.io/github/forks/crystal-linux/ame?style=flat&color=a900ff&logo=Github />
<img src=https://img.shields.io/github/issues/crystal-linux/ame?style=flat&color=a900ff&logo=Github />
<img src=https://img.shields.io/github/issues-pr/crystal-linux/ame?style=flat&color=a900f&logo=Github />
3 years ago
<a href="https://discord.gg/yp4xpZeAgW"><img alt="Discord" src="https://img.shields.io/discord/825473796227858482?color=blue&label=Discord&logo=Discord&logoColor=white"?link=https://discord.gg/yp4xpZeAgW&link=https://discord.gg/yp4xpZeAgW> </p></a>
3 years ago
3 years ago
<p align="center"> Amethyst is a fast, efficient and lightweight AUR helper and Pacman wrapper.
Made for Crystal, compatible with any Arch-based Linux distribution.</p>
3 years ago
![](screenshot.png)
3 years ago
## Basic usage
| Action | FreeBSD pkg-style alias | Pacman-style flag(s) |
| ------ | ------ | ------ |
| Install a package | ame ins | ame -S |
| Remove a package | ame rm | ame -R |
| Remove a package with its dependencies | ame purge | ame -Rs |
3 years ago
| Update repository | ame upd | ame -Sy |
| Upgrade a package | ame upg | ame -Syu |
| Search for a package in general | ame sea | ame -Ss |
| Search for a package in the repos | ame repsea | ame -Sr |
| Search for a package in aur | ame aursea | ame -Sa |
3 years ago
3 years ago
You can also use any pacman flag!
3 years ago
## How to build:
(Install cargo)
3 years ago
For release:
3 years ago
- `make clean release`
For general debug/test:
3 years ago
- `make debug`
3 years ago
Clean all build directories:
3 years ago
- `make clean`
3 years ago
<br>
<br>
3 years ago
```sh
echo "AME_UWU=YES" >> ~/.zshrc # for zsh
echo "AME_UWU=YES" >> ~/.bashrc # for bash
set -Ux AME_UWU YES # for fish
```
self explanatory