getting-started.mdx 972 Bytes
Newer Older
marshmallow's avatar
marshmallow committed
1
2
3
4
5
6
7
---
title: Getting Started
weight: 20
---

Amethyst is a fast, efficient and lightweight AUR helper and Pacman wrapper. Made for Crystal, compatible with any Arch-based Linux distribution.

marshmallow's avatar
marshmallow committed
8
![Amethyst demo](demos/ame.png)
marshmallow's avatar
marshmallow committed
9

marshmallow's avatar
marshmallow committed
10
11
12
13
14
15
16
17
18
## Installation

### Crystal Linux

Amethyst is installed on Crystal Linux automatically

### Non-Crystal Distros

1. `sudo pacman -S --needed base-devel pacman-contrib cargo`
marshmallow's avatar
marshmallow committed
19
2. `git clone https://git.getcryst.al/crystal/pkgbuilds/ame`
20
3. `cd ame && makepkg -si`
marshmallow's avatar
marshmallow committed
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

It is also in the AUR as [`ame`](https://aur.archlinux.org/packages/ame).

## Usage

Amethyst supports subcommands and Pacman-style flags. Read [Detailed Usage](usage) for more.

## Configuring

You can configure Amethyst using the `~/.config/ame/config.toml` file, which is automatically created. Each key is explained in [Config Keys](config).

```toml
# ~/.config/ame/config.toml

[base]
pacdiff_warn = true
paccache_keep = 0
paccache_keep_ins_pkgs = true

[bin]
sudo = 'sudo'
```