magic-wormhole README

The project's README from github.com/magic-wormhole/magic-wormhole. As one markdown file: README.md.

Magic Wormhole

PyPI Tests Windows Build Status codecov.io Docs Irc Matrix

Get things from one computer to another, safely.

This package provides a library and a command-line tool named wormhole, which makes it possible to get arbitrary-sized files and directories (or short pieces of text) from one computer to another. The two endpoints are identified by using identical "wormhole codes": in general, the sending machine generates and displays the code, which must then be typed into the receiving machine.

The codes are short and human-pronounceable, using a phonetically-distinct wordlist. The receiving side offers tab-completion on the codewords, so usually only a few characters must be typed. Wormhole codes are single-use and do not need to be memorized.

For complete documentation, please see https://magic-wormhole.readthedocs.io or the docs/ subdirectory.

This program uses two servers, whose source code is kept in separate repositories: the mailbox server, and the transit relay.

License, Compatibility

Magic-Wormhole is released under the MIT license, see the LICENSE file for details.

This library is compatible with Python 3.10 and higher (tested against versions up to 3.12).

Packaging, Installation

Magic Wormhole packages are included in many operating systems.

Packaging status

To install it without an OS package, follow the Installation docs.

magic-wormhole (magic-wormhole/magic-wormhole)

Searching Database…

这是什么?Magic Wormhole 是一个命令行工具和库,用于在两台电脑之间安全地传输文件、目录或简短的文本片段。它使用一个简短、易读的一次性代码,无需注册账户,也无需手动设置 IP 或网络。
这是独立的应用,还是要在终端里运行的程序?它是一个命令行工具(命令名为 wormhole),另外还提供可在程序中调用的 Python 库,并不是图形界面应用。
怎样才能让它运行起来?许多发行版已经打包了它,因此可以通过操作系统的包管理器安装;如果系统中没有对应的软件包,请参阅项目的安装文档。
使用它需要先安装 Python 吗?需要。它要求 Python 3.10 或更高版本(已测试到 3.12)。无需 API 密钥或账户,因为传输通过公共的邮箱服务器和中继服务器完成。
发送和接收到底是怎样进行的?发送方的电脑会生成并显示一个 wormhole 码,然后需要在接收方的电脑上手动输入。码很短,读音互不相似,且只能使用一次。接收方支持 Tab 键自动补全,因此通常只需输入几个字符。
Linux、macOS 和 Windows 上都能用吗?可以。作为 Python 命令行工具和库,它能跨平台运行于 Linux、macOS 和 Windows,而且已被许多操作系统的软件仓库收录。
我的数据会经过第三方服务器吗?会。传输依赖两台独立的服务器:一台邮箱服务器负责协调代码交换,一台中继服务器负责传输数据。不过,wormhole 码本身会在发送方和接收方之间建立端到端加密的通道。
我需要知道对方的 IP 地址,或者设置端口转发吗?不需要。Magic Wormhole 会通过邮箱服务器和中继服务器为你处理连接设置,因此你只需分享生成的 wormhole 码,无需提供任何网络细节。
wormhole 码可以重复使用吗?不可以。每个 wormhole 码只能使用一次,无需记住,每次传输都会重新生成。
除了文件,我还能用它传纯文本之类的内容吗?可以。它既支持传输简短的文本,也支持任意大小的文件和目录。
有没有讲座或演示可以了解它的工作原理?有。README 中附有一场 2016 年 PyCon 大会上关于 Magic Wormhole 的演讲,并提供了幻灯片和视频链接。
Size
4.2 MB
Stars
23K
Updated
CommitOct 16
Age
11y
Commits · 90 Days