Skip to content

Commit 5ac9835

Browse files
committed
Add Tailscale tsnet details to README, examples to cp command
Updated README.md to include note about `wush` using Tailscale's tsnet package. Enhanced `cp` command in `cp.go` with examples for better user guidance. Added package documentation to `tsserver/server.go`.
1 parent 5eed73f commit 5ac9835

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ 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+
> [!NOTE] > `wush` uses Tailscale's [tsnet](https://tailscale.com/kb/1244/tsnet) package
15+
> under the hood, managed by an in-memory control server on each CLI. `wush`
16+
> utilizes Tailscale's public [DERP relays](https://tailscale.com/kb/1232/derp-servers),
17+
> but no Tailscale account is required.
18+
1419
## Install
1520

1621
```bash

cmd/wush/cp.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,12 @@ func cpCmd() *serpent.Command {
108108
return &serpent.Command{
109109
Use: "cp <file>",
110110
Short: "Transfer files.",
111-
Long: "Transfer files to a " + cliui.Code("wush") + " peer. ",
111+
Long: "Transfer files to a " + cliui.Code("wush") + " peer.\n" + formatExamples(
112+
example{
113+
Description: "Copy a local file to the remote",
114+
Command: "wush cp local-file.txt",
115+
},
116+
),
112117
Middleware: serpent.Chain(
113118
serpent.RequireNArgs(1),
114119
initLogger(&verbose, ptr.To(false), logger, &logf),

tsserver/server.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// Package tsserver implements the Tailscale coordination protocol for a single
2+
// client. Heavy inspiration was taken from https://github.com/juanfont/headscale
13
package tsserver
24

35
import (

0 commit comments

Comments
 (0)