wormhole-william is a Go (golang) implementation of magic wormhole. It provides secure end-to-end encrypted file transfers between computers. The endpoints are connected using the same "wormhole code".
wormhole-william is compatible with the official python magic wormhole cli tool.
Currently, wormhole-william supports:
https://pkg.go.dev/github.com/psanford/wormhole-william/wormhole?tab=doc
$ wormhole-william send --help
Send a text message, file, or directory...
Usage:
wormhole-william send [WHAT] [flags]
Flags:
--code string human-generated code phrase
-c, --code-length int length of code (in bytes/words)
-h, --help help for send
--hide-progress suppress progress-bar display
-v, --verify display verification string (and wait for approval)
Global Flags:
--relay-url string rendezvous relay to use
$ wormhole-william receive --help
Receive a text message, file, or directory...
Usage:
wormhole-william receive [code] [flags]
Aliases:
receive, recv
Flags:
-h, --help help for receive
--hide-progress suppress progress-bar display
-v, --verify display verification string (and wait for approval)
Global Flags:
--relay-url string rendezvous relay to use
The wormhole-william CLI supports shell completion, including completing the receive code.
To enable shell completion follow the instructions from wormhole-william shell-completion -h
.
wormhole-william uses go modules so it requires a version of the go tool chain >= 1.11. If you are using a version of go that supports modules you can clone the repo outside of your GOPATH and do a go build
in the top level directory.
To just install via the go tool run:
go install github.com/psanford/wormhole-william@latest
Sending text:
package main
import (
"context"
"fmt"
"io/ioutil"
"log"
"github.com/psanford/wormhole-william/wormhole"
)
func sendText() {
var c wormhole.Client
msg := "Dillinger-entertainer"
ctx := context.Background()
code, status, err := c.SendText(ctx, msg)
if err != nil {
log.Fatal(err)
}
fmt.Println("On the other computer, please run: wormhole receive")
fmt.Printf("Wormhole code is: %s\n", code)
s := <-status
if s.OK {
fmt.Println("OK!")
} else {
log.Fatalf("Send error: %s", s.Error)
}
}
func recvText(code string) {
var c wormhole.Client
ctx := context.Background()
msg, err := c.Receive(ctx, code)
if err != nil {
log.Fatal(err)
}
if msg.Type != wormhole.TransferText {
log.Fatalf("Expected a text message but got type %s", msg.Type)
}
msgBody, err := ioutil.ReadAll(msg)
if err != nil {
log.Fatal(err)
}
fmt.Println("got message:")
fmt.Println(msgBody)
}
See the cli tool and examples directory for working examples of how to use the API to send and receive text, files and directories.