{"id":13509844,"url":"https://github.com/psanford/wormhole-william","last_synced_at":"2025-04-23T20:50:45.294Z","repository":{"id":38106841,"uuid":"204979453","full_name":"psanford/wormhole-william","owner":"psanford","description":"End-to-end encrypted file transfer. A magic wormhole CLI and API in Go (golang).","archived":false,"fork":false,"pushed_at":"2025-03-30T02:45:35.000Z","size":216,"stargazers_count":1134,"open_issues_count":3,"forks_count":61,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-04-11T03:38:10.844Z","etag":null,"topics":["cli","encryption","end-to-end-encryption","file-transfer","go","golang","magic-wormhole"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/psanford.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-08-28T16:46:54.000Z","updated_at":"2025-04-06T23:04:57.000Z","dependencies_parsed_at":"2024-01-12T19:47:21.543Z","dependency_job_id":"ea0f939d-b40c-4b56-afc0-54e890bc0652","html_url":"https://github.com/psanford/wormhole-william","commit_stats":{"total_commits":156,"total_committers":9,"mean_commits":"17.333333333333332","dds":"0.19871794871794868","last_synced_commit":"6ae2628b304f8af7732de42e542c8d9aab371198"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psanford%2Fwormhole-william","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psanford%2Fwormhole-william/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psanford%2Fwormhole-william/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psanford%2Fwormhole-william/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/psanford","download_url":"https://codeload.github.com/psanford/wormhole-william/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250514644,"owners_count":21443207,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","encryption","end-to-end-encryption","file-transfer","go","golang","magic-wormhole"],"created_at":"2024-08-01T02:01:14.288Z","updated_at":"2025-04-23T20:50:45.246Z","avatar_url":"https://github.com/psanford.png","language":"Go","funding_links":[],"categories":["Go","cli","Software"],"sub_categories":["Ad-hoc Service"],"readme":"# wormhole-william\n\nwormhole-william is a Go (golang) implementation of [magic wormhole](https://magic-wormhole.readthedocs.io/en/latest/). It provides secure end-to-end encrypted file transfers between computers. The endpoints are connected using the same \"wormhole code\".\n\nwormhole-william is compatible with the official [python magic wormhole cli tool](https://github.com/warner/magic-wormhole).\n\nCurrently, wormhole-william supports:\n- sending and receiving text over the wormhole protocol\n- sending and receiving files over the transit protocol\n- sending and receiving directories over the transit protocol\n\n## Docs\n\nhttps://pkg.go.dev/github.com/psanford/wormhole-william/wormhole?tab=doc\n\n## CLI Usage\n\n```\n$ wormhole-william send --help\nSend a text message, file, or directory...\n\nUsage:\n  wormhole-william send [WHAT] [flags]\n\nFlags:\n      --code string       human-generated code phrase\n  -c, --code-length int   length of code (in bytes/words)\n  -h, --help              help for send\n      --hide-progress     suppress progress-bar display\n  -v, --verify            display verification string (and wait for approval)\n\nGlobal Flags:\n      --relay-url string   rendezvous relay to use\n\n\n$ wormhole-william receive --help\nReceive a text message, file, or directory...\n\nUsage:\n  wormhole-william receive [code] [flags]\n\nAliases:\n  receive, recv\n\nFlags:\n  -h, --help            help for receive\n      --hide-progress   suppress progress-bar display\n  -v, --verify          display verification string (and wait for approval)\n\nGlobal Flags:\n      --relay-url string   rendezvous relay to use\n```\n\n### CLI tab completion\n\nThe wormhole-william CLI supports shell completion, including completing the receive code.\nTo enable shell completion follow the instructions from `wormhole-william shell-completion -h`.\n\n\n## Building the CLI tool\n\nwormhole-william uses go modules so it requires a version of the go tool chain \u003e= 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.\n\nTo just install via the go tool run:\n\n```\ngo install github.com/psanford/wormhole-william@latest\n```\n\n## API Usage\n\nSending text:\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\n\t\"github.com/psanford/wormhole-william/wormhole\"\n)\n\nfunc sendText() {\n\tvar c wormhole.Client\n\n\tmsg := \"Dillinger-entertainer\"\n\n\tctx := context.Background()\n\n\tcode, status, err := c.SendText(ctx, msg)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Println(\"On the other computer, please run: wormhole receive\")\n\tfmt.Printf(\"Wormhole code is: %s\\n\", code)\n\n\ts := \u003c-status\n\n\tif s.OK {\n\t\tfmt.Println(\"OK!\")\n\t} else {\n\t\tlog.Fatalf(\"Send error: %s\", s.Error)\n\t}\n}\n\nfunc recvText(code string) {\n\tvar c wormhole.Client\n\n\tctx := context.Background()\n\tmsg, err := c.Receive(ctx, code)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif msg.Type != wormhole.TransferText {\n\t\tlog.Fatalf(\"Expected a text message but got type %s\", msg.Type)\n\t}\n\n\tmsgBody, err := ioutil.ReadAll(msg)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tfmt.Println(\"got message:\")\n\tfmt.Println(msgBody)\n}\n```\n\nSee the [cli tool](https://github.com/psanford/wormhole-william/tree/master/cmd) and [examples](https://github.com/psanford/wormhole-william/tree/master/examples) directory for working examples of how to use the API to send and receive text, files and directories.\n\n## Third Party Users of Wormhole William\n\n- [rymdport](https://github.com/Jacalz/rymdport): A cross-platform Magic Wormhole graphical user interface\n- [riftshare](https://github.com/achhabra2/riftshare): Desktop filesharing app\n- [termshark](https://github.com/gcla/termshark): A terminal UI for tshark\n- [tmux-wormhole](https://github.com/gcla/tmux-wormhole): tmux wormhole integration\n- [wormhole-william-mobile](https://github.com/psanford/wormhole-william-mobile): Android wormhole-william app\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsanford%2Fwormhole-william","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpsanford%2Fwormhole-william","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsanford%2Fwormhole-william/lists"}