@hiverra/portal
v0.10.1
Published
Hiverra Portal CLI
Downloads
20
Readme
Portal
Portal started as a personal way to move files from phone to computer. It is now a CLI tool designed to make file transfers effortless.
Overview
Portal (Hiverra Portal) is a local-first file transfer tool built for simple, reliable sharing across devices. Today it focuses on CLI ↔ CLI transfers. Browser flows are planned.
What Portal Does (Today)
- CLI ↔ CLI transfers over local networks
- Files and folders (recursive sends supported)
- Discovery mode with identity verification
- Direct IP mode for quick sends
- Transfer history with export and cleanup
- Optional no-compress mode (tar only)
Planned
- CLI ↔ Browser
- Browser ↔ CLI
Who It’s For
Portal is for anyone who wants a fast, local, no-fuss way to move files between devices without relying on external services. It is ideal for personal workflows and small team transfers on the same network.
Install
Release Installers (Recommended)
Shell script (Linux/macOS)
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-installer.sh | shPowerShell (Windows)
powershell -ExecutionPolicy Bypass -c "irm https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-installer.ps1 | iex"npm (prebuilt binaries)
npm install [email protected]Android / Termux
curl -LsSf https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-android-installer.sh | shDirect download
- Download the release asset for your OS from GitHub Releases.
Build From Source
- Install Rust
cargo build -p hiverra-portalQuick Start
- Run setup
portal config setup- On receiver
portal receive- On sender
portal send path/to/fileUsage Examples
Start receiver
portal receiveSend via discovery
portal send --to <username> path/to/fileSend via direct IP
portal send --address <ip> --port <port> path/to/fileSend a folder (recursive)
portal send -r path/to/folderNo-compress
portal send --no-compress path/to/fileHistory (list + export)
portal history
portal history export --detailed --output portal_history.jsonUpdate To update Portal:
portal updateHow to Run or Use It
Portal is a command-line tool. Common commands:
Send a file Use this to send a specific file. If no file is specified, Portal will prompt you to select one.
portal send <file_path>Send with discovery (recommended) Sends to a user by username and verifies identity.
portal send --to <username> <file_path>Send via direct IP Use this when you already know the receiver’s IP and port.
portal send --address <IP_ADDRESS> --port <PORT> <file_path>Receive Puts Portal into listening mode to receive files.
portal receiveReceive on a custom port
portal receive --port <PORT>Configuration setup Interactive setup to configure username and default port.
portal config setupSet a configuration value
portal config set <key> <value>Show a configuration value
portal config show <key>List current configuration
portal config listDocumentation
Author
Spectra010s
License
Hiverra Portal: A lightweight CLI tool to transfer files between devices locally or remotely.
