Skip to content

Commit 7a4d5d3

Browse files
committed
chore: update README
1 parent e45670c commit 7a4d5d3

File tree

1 file changed

+30
-50
lines changed

1 file changed

+30
-50
lines changed

README.md

Lines changed: 30 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,34 @@ shells over a peer-to-peer WireGuard connection. It's similar to
1111
1. Automatic peer-to-peer connections over UDP.
1212
1. Endless possibilities; rsync, ssh, etc.
1313

14+
## Basic Usage
15+
16+
On the host machine:
17+
18+
```bash
19+
$ wush host
20+
Picked DERP region Toronto as overlay home
21+
Your auth key is:
22+
> 112v1RyL5KPzsbMbhT7fkEGrcfpygxtnvwjR5kMLGxDHGeLTK1BvoPqsUcjo7xyMkFn46KLTdedKuPCG5trP84mz9kx
23+
Use this key to authenticate other wush commands to this instance.
24+
```
25+
26+
On the client machine:
27+
28+
```bash
29+
# Copy a file to the host
30+
$ wush cp 1gb.txt
31+
Uploading "1gb.txt" 100% |██████████████████████████████████████████████| (2.1/2.1 GB, 376 MB/s)
32+
33+
# Open a shell to the host
34+
$ wush ssh
35+
┃ Enter the Auth key:
36+
> 112v1RyL5KPzsbMbhT7fkEGrcfpygxtnvwjR5kMLGxDHGeLTK1BvoPqsUcjo7xyMkFn46KLTdedKuPCG5trP84mz9kx
37+
coder@colin:~$
38+
```
39+
40+
[![asciicast](https://asciinema.org/a/ZrCNiRRkeHUi5Lj3fqC3ovLqi.svg)](https://asciinema.org/a/ZrCNiRRkeHUi5Lj3fqC3ovLqi)
41+
1442
> [!NOTE]
1543
> `wush` uses Tailscale's [tsnet](https://tailscale.com/kb/1244/tsnet) package
1644
> under the hood, managed by an in-memory control server on each CLI. We utilize
@@ -20,11 +48,13 @@ shells over a peer-to-peer WireGuard connection. It's similar to
2048
## Install
2149

2250
Using install script
51+
2352
```bash
2453
curl -fsSL https://wush.dev/install.sh | sh
2554
```
2655

2756
Using Homebrew
57+
2858
```bash
2959
brew install wush
3060
```
@@ -41,56 +71,6 @@ For a manual installation, see the [latest release](https://github.com/coder/wus
4171
> sudo setcap cap_net_admin=eip $(which wush)
4272
> ```
4373
44-
## Basic Usage
45-
46-
[![asciicast](https://asciinema.org/a/ZrCNiRRkeHUi5Lj3fqC3ovLqi.svg)](https://asciinema.org/a/ZrCNiRRkeHUi5Lj3fqC3ovLqi)
47-
48-
On the host machine:
49-
50-
```bash
51-
$ wush host
52-
Picked DERP region Toronto as overlay home
53-
Your auth key is:
54-
> 112v1RyL5KPzsbMbhT7fkEGrcfpygxtnvwjR5kMLGxDHGeLTK1BvoPqsUcjo7xyMkFn46KLTdedKuPCG5trP84mz9kx
55-
Use this key to authenticate other wush commands to this instance.
56-
05:18:59 WireGuard is ready
57-
05:18:59 SSH server listening
58-
```
59-
60-
On the client machine:
61-
62-
```bash
63-
# Copy a file to the receiver
64-
$ wush cp 1gb.txt
65-
Auth information:
66-
> Server overlay STUN address: Disabled
67-
> Server overlay DERP home: Toronto
68-
> Server overlay public key: [NFWN0]
69-
> Server overlay auth key: [mTbpN]
70-
Bringing WireGuard up..
71-
WireGuard is ready!
72-
Received peer
73-
Peer active with relay nyc
74-
Peer active over p2p 172.20.0.8:53768
75-
Uploading "1gb.txt" 100% |██████████████████████████████████████████████| (2.1/2.1 GB, 376 MB/s)
76-
77-
# Open a shell to the receiver
78-
$ wush ssh
79-
┃ Enter the receiver's Auth key:
80-
┃ > 112v1RyL5KPzsbMbhT7fkEGrcfpygxtnvwjR5kMLGxDHGeLTK1BvoPqsUcjo7xyMkFn46KLTdedKuPCG5trP84mz9kx
81-
Auth information:
82-
> Server overlay STUN address: Disabled
83-
> Server overlay DERP home: Toronto
84-
> Server overlay public key: [sEIS1]
85-
> Server overlay auth key: [w/sYF]
86-
Bringing WireGuard up..
87-
WireGuard is ready!
88-
Received peer
89-
Peer active with relay nyc
90-
Peer active over p2p 172.20.0.8:44483
91-
coder@colin:~$
92-
```
93-
9474
## Technical Details
9575
9676
`wush` doesn't require you to trust any 3rd party authentication or relay

0 commit comments

Comments
 (0)