Skip to content

magic-wormhole/magic-wormhole

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Feb 23, 2025
8c700d1 · Feb 23, 2025
Nov 20, 2024
Feb 23, 2025
Sep 16, 2024
Aug 25, 2021
Oct 23, 2024
Jan 25, 2025
Oct 27, 2022
May 24, 2016
Feb 10, 2015
Aug 22, 2023
Oct 23, 2024
Apr 4, 2020
Feb 10, 2015
Oct 16, 2018
Oct 23, 2024
Dec 6, 2024
Jan 24, 2024
Aug 12, 2023
Feb 21, 2025
May 24, 2024
Nov 13, 2024
Jul 31, 2017
Dec 10, 2024
Aug 12, 2023
Oct 25, 2023
Apr 25, 2024
Sep 20, 2023
Sep 20, 2023

Repository files navigation

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.8 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.