peerline 0.1.0-beta.1 → 0.1.0-beta.4

package/README.md

@@ -21,7 +21,7 @@ Peerline has two roles:
 - Receiver: runs `peerline recv`, keeps listening for incoming transfers until you quit or the idle timeout expires, and prints a `name`, `code`, and direct endpoint.
 - Sender: runs `peerline send`, points at the receiver by name/code or IP/code, and provides the files or folders to send.
 
-For named transfers, the receiver publishes a short-lived descriptor keyed by the shared name and code. The sender derives the same lookup key, discovers candidate routes, and tries them in order. Peerline prefers direct LAN or public TCP endpoints first, then libp2p routes such as DCUtR and WebRTC TURN. Relay data fallback is available only when explicitly enabled.
+For named transfers, the receiver publishes a short-lived descriptor keyed by the shared name and code. The sender derives the same lookup key, discovers candidate routes, and tries them in order. Peerline prefers direct LAN or public TCP endpoints first, then libp2p routes such as DCUtR and WebRTC direct. When direct and hole-punched routes are unavailable, Peerline falls back to libp2p relay transport by default while keeping file contents protected by Peerline's end-to-end encryption.
 
 Peerline also probes HTTP rendezvous first, with a default endpoint at `https://peerline.pwp.sh`, then falls back to DHT and mDNS. Official builds use a private mTLS-protected rendezvous endpoint; set `PEERLINE_RENDEZVOUS_CLIENT_IDENTITY_PATH` or `PEERLINE_RENDEZVOUS_CLIENT_IDENTITY_PEM` to a PEM bundle with the client certificate and private key, or set `PEERLINE_RENDEZVOUS_URLS` / `PEERLINE_RENDEZVOUS_URL` to point at another compatible rendezvous service. Use `PEERLINE_RENDEZVOUS_TOKEN` only when the rendezvous service expects a shared secret.
 
@@ -74,7 +74,7 @@ The receiver prints values like:
 ```text
 peerline recv
 name: frost-827
-code: fig-mint-1234-5678
+code: fig-mint-rose-123456
 direct: 0.0.0.0:43117
 waiting for transfers over direct TCP or libp2p...
 idle timeout: 10 min (change with --idle-timeout-minutes)
@@ -83,8 +83,8 @@ idle timeout: 10 min (change with --idle-timeout-minutes)
 Send a file, multiple files, or a folder by name and code:
 
 ```sh
-peerline send frost-827 fig-mint-1234-5678 ./file.txt
-peerline send frost-827 fig-mint-1234-5678 ./file.txt ./notes.md ./photos
+peerline send frost-827 fig-mint-rose-123456 ./file.txt
+peerline send frost-827 fig-mint-rose-123456 ./file.txt ./notes.md ./photos
 ```
 
 Receive with a saved name:
@@ -97,14 +97,14 @@ peerline recv
 After a name is saved, you can receive with only a fresh code:
 
 ```sh
-peerline recv fig-mint-1234-5678
+peerline recv fig-mint-rose-123456
 ```
 
 Use a direct IP address when discovery is not needed:
 
 ```sh
-peerline send 192.168.1.23:43117 ./file.txt --code=fig-mint-1234-5678
-peerline send 192.168.1.23 ./folder --code=fig-mint-1234-5678
+peerline send 192.168.1.23:43117 ./file.txt --code=fig-mint-rose-123456
+peerline send 192.168.1.23 ./folder --code=fig-mint-rose-123456
 ```
 
 When the port is omitted, Peerline probes the default direct window `43117-43121`.
@@ -117,12 +117,19 @@ Receiver options:
 peerline recv [NAME_OR_CODE] [CODE] --port 43117
 peerline recv [NAME_OR_CODE] [CODE] --overwrite
 peerline recv [NAME_OR_CODE] [CODE] --no-tui
-peerline recv [NAME_OR_CODE] [CODE] --allow-relay-fallback
+peerline recv [NAME_OR_CODE] [CODE] --no-relay-fallback
+peerline recv [NAME_OR_CODE] [CODE] --no-tor
 peerline recv [NAME_OR_CODE] [CODE] --idle-timeout-minutes 30
+peerline recv [NAME_OR_CODE] [CODE] --tunnel cloudflared
+peerline recv [NAME_OR_CODE] [CODE] --tunnel localtunnel
+peerline recv [NAME_OR_CODE] [CODE] --tunnel tmole
+peerline recv [NAME_OR_CODE] [CODE] --tunnel tunnelmole
 ```
 
 `--port` starts the 5-port direct window; Peerline will try that port and the next four.
 `--idle-timeout-minutes` defaults to `10`; set it to `0` to wait until you quit manually.
+Tor onion receive is attempted by default when the `tor` command is available; use `--no-tor` or `PEERLINE_DISABLE_TOR=1` to skip it.
+`--tunnel` starts a public tunnel on the receiver side. `cloudflared`, `localtunnel`, `tmole`, and `tunnelmole` are accepted values.
 
 Sender options:
 
@@ -131,17 +138,30 @@ peerline send <name> <code> <path...> --compression auto
 peerline send <name> <code> <path...> --compression none
 peerline send <name> <code> <path...> --compression zstd
 peerline send <name> <code> <path...> --compression lzma
-peerline send <name> <code> <path...> --allow-relay-fallback
+peerline send <name> <code> <path...> --no-relay-fallback
 peerline send --name <name> --code <code> <path...>
 ```
 
-Relay fallback must be enabled on both sides when you want Peerline to use relay data paths. Direct and hole-punched routes are attempted before relay fallback.
+Relay fallback is enabled by default. Direct and hole-punched routes are attempted before relay fallback; pass `--no-relay-fallback` on both sides when you want to require a direct or hole-punched path.
 In the send TUI, a failed attempt stays on screen and offers `r` to retry the same send or `q`/Esc to quit.
 
+Network environment variables:
+
+```sh
+PEERLINE_RELAY_PEERS=/ip4/203.0.113.10/tcp/4001/p2p/...
+PEERLINE_DISABLE_RELAY_FALLBACK=1
+PEERLINE_DISABLE_UPNP=1
+PEERLINE_BOOTSTRAP=/dnsaddr/bootstrap.libp2p.io/p2p/...
+PEERLINE_WEBRTC_ICE_SERVERS='[{"urls":["turn:turn.example.net:3478?transport=udp"],"username":"user","credential":"pass"}]'
+```
+
+`PEERLINE_RELAY_PEERS` should contain comma-separated libp2p relay-capable peer multiaddrs. If it is not set, Peerline tries the bootstrap peers as relay candidates. UPnP is enabled by default for home-router TCP and libp2p external address discovery; set `PEERLINE_DISABLE_UPNP=1` to turn it off.
+WebRTC direct transport ships with default Open Relay Project TURN candidates for `staticauth.openrelay.metered.ca` on ports `80` and `443`, including UDP, TCP, and TLS-style `turns` URLs. Peerline generates short-lived static-auth credentials for those defaults. Set `PEERLINE_WEBRTC_ICE_SERVERS` to a JSON array of WebRTC ICE server objects to replace the defaults; set it to an empty string to disable configured ICE servers entirely.
+
 ## Current Status
 
 - Direct IP send and receive works.
-- Named discovery now uses HTTP rendezvous first, then Kademlia provider records, mDNS, DCUtR, relay fallback, and libp2p-webrtc's built-in ICE servers.
+- Named discovery now uses HTTP rendezvous first, then Kademlia provider records, mDNS, UPnP-assisted direct endpoints, DCUtR, relay fallback, and libp2p-webrtc direct.
 - Files, multiple files, and folders are archived with safe relative paths, BLAKE3 integrity checks, and streaming zstd/lzma compression support.
 - Receivers stay open across multiple incoming transfers, with a configurable idle auto-exit.
 - Conflicts default to non-overwrite behavior, with TUI-driven handling in the receiver flow.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "peerline",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.4",
   "description": "P2P post-quantum encrypted file transfer CLI",
   "repository": {
     "type": "git",