speer-chat 0.2.0

terminal chat app for speer
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

# speer-chat

rust terminal chat app using speer.

![speer-chat screenshot](assets/tui_screenshot.png)

it does local discovery with mdns, connects over tcp, negotiates noise xx and
yamux, then speaks `/speer/chat/1.0.0`.

it has chat messages, a small network console, peer stats, themes, and basic
file transfer.

## install

you can install speer with this command
```bash
cargo install speer-chat
```
## run

```bash
cargo run -- --nick alice
cargo run -- --nick bob --theme midnight
```

use a fixed port if you want another client to target this instance:

```bash
cargo run -- --nick alice --port 4001
```

inside the app:

```text
/status /inspect /id /peers /clear /theme /send /accept /quit
```

## commands

- `/status` - local address, uptime, peer count, message stats
- `/inspect` - connection details for each peer
- `/id` - local nick, peer id, and multiaddr
- `/peers` - quick peer list
- `/theme modern|midnight|original` - swap colors
- `/send <path>` - offer a file
- `/accept [id]` - accept an incoming file
- `/quit` - leave

received files go into `speer_received/`.

## build

```bash
cargo check
cargo build --release
```

this crate depends on `speer` with the `full-chat` feature, so it can reach the
lower-level ffi needed for tcp, mdns, noise, yamux, protobuf framing, and peer
ids.