portal
A command-line utility for secure, encrypted file transfers between computers with direct or relayed connections.
What is portal?
Portal is a command-line file transfer utility that securely sends files and folders between computers using end-to-end encryption. It establishes direct connections when possible (e.g., on the same local network) or uses a relay server as a fallback, ensuring fast and private transfers.
Developers, system administrators, and technical users who need a quick, secure way to transfer files between machines via the command line without relying on cloud storage or email.
Portal offers a seamless, encrypted transfer experience with zero configuration for direct transfers, a self-hostable relay option, and an intuitive terminal interface, making it a reliable alternative to traditional file-sharing methods.
Overview
Portal is a quick and easy command-line file transfer utility from any computer to another 🌌 ✨
Use Cases
Best For
- Transferring files between computers on the same local network
- Sending sensitive files with end-to-end encryption
- Quick ad-hoc file sharing without cloud storage
- Command-line users who prefer terminal-based tools
- Self-hosting a file transfer relay for privacy
- Automating file transfers in scripts or workflows
Not Ideal For
- Users requiring a graphical interface for file transfers
- Environments with strict firewalls blocking both direct and relay connections
- Long-term file storage or sharing via permanent, accessible links
- Fully automated workflows needing API-based integration without CLI interaction
Pros & Cons
Pros
Uses PAKE2 for password-authenticated key agreement, ensuring files are encrypted before transfer and the relay never sees contents, as detailed in the technical explanation.
Automatically establishes peer-to-peer connections on the same network, bypassing the relay for faster transfers, demonstrated in the demo GIF for same-network scenarios.
Allows users to host custom relay servers with 'portal serve', providing control over data routing and privacy, as shown in the configuration and hosting instructions.
Offers a visually rich terminal interface with real-time progress updates, enhancing user experience during transfers, highlighted in the features as a 'shiny UI'.
Cons
Relies on either direct network access or a functioning relay server; transfers fail if both are blocked, and the README admits fallback reliance without offline alternatives.
Lacks built-in support for resuming interrupted transfers, which could be inefficient for large files, as the README does not mention any checkpoint or resume features.
Hosting a custom relay requires manual server management and tools like jq for log parsing, adding overhead compared to simpler, out-of-the-box solutions.
Frequently Asked Questions
Related Projects
rclone"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files
crocEasily and securely send things from one computer to another :crocodile: :package:
ffsend:mailbox_with_mail: Easily and securely share files from the command line. A fully featured Firefox Send client.
sharingSharing is a command-line tool to share directories and files from the CLI to iOS and Android devices without the need of an extra client app
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.