remosidian 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +24 -0
  2. package/dist/remosidian.mjs +26639 -20481
  3. package/package.json +4 -1
package/README.md CHANGED
@@ -48,6 +48,30 @@ stored in `~/.remosidian/pairings.json` and reused on subsequent connections.
48
48
  | `remosidian init` | Generate `~/.remosidian/config.json` interactively. |
49
49
  | `remosidian --version` | Print the installed version. |
50
50
 
51
+ ## Options
52
+
53
+ ```bash
54
+ remosidian --access=local # LAN/local pairing only
55
+ remosidian --access=remote --force # Force a fresh Cloudflare Tunnel URL
56
+ remosidian --access=https://<your-tunnel-url> # Use your own relay URL
57
+ remosidian --access=<tailscale-or-lan-host> # Use a direct private-network host
58
+ remosidian --access=<host>,<fallback1> # Add fallback private-network hosts
59
+ remosidian --access= # Clear saved relay URL
60
+ ```
61
+
62
+ Remote access is enabled by default for `remosidian` and `remosidian start`. Use
63
+ `--access=local` when you want a LAN-only QR code for that run. Legacy aliases
64
+ still work: `--local`, `--relay`, `--host`, `--fallback-hosts`, `--remote`, and
65
+ `--tunnel`.
66
+
67
+ Managed Cloudflare Tunnels use cloudflared's `auto` transport so QUIC is preferred
68
+ when UDP is available and HTTP/2 remains the fallback. The CLI checks its bundled,
69
+ user-owned cloudflared binary for updates at most once every 24 hours. A failed
70
+ check does not prevent startup, and system package-manager binaries are never
71
+ modified. Versions older than 2026.5.2 temporarily stay on HTTP/2 because their
72
+ automatic QUIC fallback can delay tunnel readiness for minutes. Update metadata
73
+ is stored in `~/.remosidian/cloudflared-update.json`.
74
+
51
75
  ## Data directory
52
76
 
53
77
  By default, Remosidian stores identity, pairings, and the QR PNG under `~/.remosidian/`.