How to Use the Command 'wormhole' (with Examples)

Magic Wormhole is a simple yet powerful command-line tool that enables users to transfer files and text between computers safely and efficiently. Designed for ease of use, this tool ensures secure transmission without the typical complexities associated with SSH or FTP. Users generate a temporary code that allows the sender and receiver to communicate directly, making the process intuitive and secure.

Use Case 1: Send a File

Code:

wormhole send path/to/file

Motivation:
Suppose you need to send a large file to a colleague who is working remotely. Traditionally, emailing such a file would be cumbersome, especially with size limitations and security concerns. Magic Wormhole provides an ideal solution by enabling you to securely and quickly send a file without those limitations. This use case is particularly useful when you need to transfer files without relying on cloud storage services, which may have additional privacy concerns or access issues.

Explanation:

• wormhole: This is the main command used to initiate the operation of sending or receiving.
• send: Specifies that you want to send a file. This subcommand tells Magic Wormhole to prepare for a file transfer process.
• path/to/file: This is the path on your local computer’s file system where the file you wish to send is located. It should be replaced with the actual path to your desired file.

Example Output:
When you run the command, you will receive a unique wormhole code like this:

Wormhole code is: 7-honest-horses

This code needs to be shared with the receiver so they can use it to accept the file.

Use Case 2: Receive a File

Code:

wormhole receive wormhole_code

Motivation:
Imagine you are working from a remote location and need to receive an important document from your colleague. Instead of setting up a complicated VPN connection or using less secure methods, you can use Magic Wormhole to receive files safely with a simple code. This example highlights the importance for remote workers or teams that rely heavily on a secure method for exchanging files.

Explanation:

• wormhole: Again, the main command that starts the process.
• receive: This subcommand tells Magic Wormhole to receive an incoming file. It places the program into listening mode for any incoming transfers.
• wormhole_code: This is the unique code provided by the sender after initiating a transfer. It acts as a one-time secure key that uniquely identifies the transaction and can be used only once.

Example Output:
Upon entering the command with the correct code, you’ll see:

Receiving file (filename.ext) of size 14 MB
Receiving (progress bar)
Transfer complete

This indicates that the file has been received successfully.

Use Case 3: Send Raw Text

Code:

wormhole send

Motivation:
There are scenarios when you might want to send small snippets of text or code quickly. For example, if you’re troubleshooting a problem with a distant team member, and need to quickly share error logs or configuration snippets, sending raw text can be more efficient than creating a file and sending it. This convenience makes it an excellent choice for developers and IT professionals who need to frequently exchange small pieces of text information.

Explanation:

• wormhole: Initiates the tool.
• send: Even without a file path, this command can be used to start an interactive text sending session. Omitting the file path tells Magic Wormhole that you intend to input the data directly.

Example Output:
The tool will wait for you to input the text directly in the terminal. After typing your text and pressing Ctrl+D to end the input, you’ll see:

Text is sent. Wormhole code is: 4-brave-otters

This code needs to be shared with the recipient to retrieve the text data.

Conclusion:

Magic Wormhole represents a simple, secure, and efficient method for transferring files and text between computers. With its ease of use and strong encryption, it eliminates many of the headaches traditionally associated with data transfers. Whether you’re sending important files to a colleague or swiftly passing raw text data, Magic Wormhole offers a streamlined solution for secure transmission with just a few commands.