pobsd 0.1.2

Simple tool to interact with the PlayOnBSD database
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

[![Rust](https://github.com/Hukadan/pobsd-rs/actions/workflows/rust.yml/badge.svg)](https://github.com/Hukadan/pobsd-rs/actions/workflows/rust.yml)
[![rust-clippy analyze](https://github.com/Hukadan/pobsd-rs/actions/workflows/rust-clippy.yml/badge.svg)](https://github.com/Hukadan/pobsd-rs/actions/workflows/rust-clippy.yml)

## pobsd
pobsd is a tool written in Rust designed to interact with the PlayOnBSD
database that can be find [here](https://github.com/playonbsd/OpenBSD-Games-Database)

It makes use of both `plege(2)` and `unveil(2)`.

At the moment, it provides three functionalities:
- checking the database integrity (at the moment, in a minimal way)
- exporting the database in a different format (at the moment, only json)
- browsing the database (at the moment, only in read-only mode)


### Installing
You can install it using `cargo` with `cargo install pobsd`.
Make sure to update to your `$PATH` to be able to use 
it (usually by adding `$HOME/.cargo/bin`).

### Checking the database integrity
For now, it boils down to checking if the parser can
parse the database and tells where the parser found
errors. 
```
$ pobsd check games.db 
> 356 games parsed without error
$ pobsd check faulty-games.db
> 356 games parsed
> Errors occured at lines 15, 24.
```
If there is an error, it should be fixed before using the
other functions of pobsd since this could lead to wrong
data being displayed or exported.

### Exporting the database
At the moment, the only format available is json.
```
$ pobsd export games.db games.json 
```

### Browsing
The last (but not the least) function is the browse function.
It provides a nice yet simple terminal interface for browsing
and searching the database.
[![asciicast](https://asciinema.org/a/563130.svg)](https://asciinema.org/a/563130)

### Credits
Reading [https://github.com/graymind75/passmng](https://github.com/graymind75/passmng) source
code helped me a lot to implement the TUI.