summaryrefslogtreecommitdiff
path: root/docs/guide/libraries/greet.md
blob: 9c2f1b73a63510bf14e94a6e072ffaa48f2637ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# Greet

Library and CLI tool for sending requests to [greetd](https://sr.ht/~kennylevinsen/greetd/).

## Usage

You can browse the [Greet reference](https://aylur.github.io/libastal/greet).

### CLI

```sh
astal-greet --help
```

### Library

:::code-group

```js [<i class="devicon-javascript-plain"></i> JavaScript]
import Greet from "gi://AstalGreet"

Greet.login("username", "password", "compositor", (_, res) => {
    try {
        Greet.login_finish(res)
    } catch (err) {
        printerr(err)
    }
})
```

```py [<i class="devicon-python-plain"></i> Python]
# Not yet documented

```

```lua [<i class="devicon-lua-plain"></i> Lua]
local Greet = require("lgi").require("AstalGreet")

Greet.login("username", "password", "compositor", function (_, res)
    local err = Greet.login_finish(res)
    if err ~= nil then
        print(err)
    end
end)
```

```vala [<i class="devicon-vala-plain"></i> Vala]
try {
    yield AstalGreet.login("username", "password", "compositor");
} catch (Error err) {
    printerr(err.message);
}
```

:::

## Installation

1. install dependencies

:::code-group

```sh [<i class="devicon-archlinux-plain"></i> Arch]
sudo pacman -Syu meson vala valadoc json-glib gobject-introspection
```

```sh [<i class="devicon-fedora-plain"></i> Fedora]
sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
```

```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
sudo apt install meson valac valadoc libjson-glib-dev gobject-introspection
```

:::

::: info
Although `greetd` is not a direct build dependency,
it should be self-explanatory that the daemon is required to be available at runtime.
:::

2. clone repo

```sh
git clone https://github.com/aylur/astal.git
cd astal/lib/greet
```

3. install

```sh
meson setup --prefix /usr build
meson install -C build
```