dunkirk.sh
Kieran's opinionated (and probably slightly dumb) nix config
1# bore (client)
2
3Interactive CLI for creating tunnels to the [bore server](../services/bore.md). Built with gum, supports HTTP, TCP, and UDP tunnels.
4
5## Options
6
7All options under `atelier.bore`:
8
9| Option | Type | Default | Description |
10|--------|------|---------|-------------|
11| `enable` | bool | `false` | Install the bore CLI |
12| `serverAddr` | string | `"bore.dunkirk.sh"` | frps server address |
13| `serverPort` | port | `7000` | frps server port |
14| `domain` | string | `"bore.dunkirk.sh"` | Base domain for constructing public URLs |
15| `authTokenFile` | path | — | Path to frp auth token file |
16
17## Usage
18
19```bash
20bore # Interactive menu
21bore myapp 3000 # Quick HTTP tunnel: myapp.bore.dunkirk.sh → localhost:3000
22bore myapp 3000 --auth # With OAuth authentication
23bore myapp 3000 --save # Save to bore.toml for reuse
24```
25
26Tunnels can also be defined in a `bore.toml`:
27
28```toml
29[myapp]
30port = 3000
31auth = true
32labels = ["dev"]
33```