@hahahhh/sshx 0.0.4-rc.0 → 0.0.4-rc.1
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.
- package/README.md +50 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -71,6 +71,56 @@ Set `features.remoteFs: true` to expose the command initiator's current director
|
|
|
71
71
|
|
|
72
72
|
FUSE is a hard dependency when this feature is enabled: a mount failure aborts the command even when `strict` is false. Linux needs `/dev/fuse` plus `fusermount`/`fusermount3`; macOS needs a current macFUSE installation and is currently beta. The remote target must be Linux with FUSE available.
|
|
73
73
|
|
|
74
|
+
#### FUSE setup
|
|
75
|
+
|
|
76
|
+
The machine receiving the mounted view needs a working FUSE runtime. The Linux target therefore always needs FUSE for `sshx remote`; a macOS client also needs macFUSE when a remote shell runs `sshx local` and mounts the remote working directory back on the Mac.
|
|
77
|
+
|
|
78
|
+
**Linux target/client**
|
|
79
|
+
|
|
80
|
+
Install the FUSE 3 userspace tools (the kernel normally already includes the FUSE driver):
|
|
81
|
+
|
|
82
|
+
```sh
|
|
83
|
+
# Debian / Ubuntu
|
|
84
|
+
sudo apt-get update && sudo apt-get install -y fuse3
|
|
85
|
+
|
|
86
|
+
# Fedora / RHEL-family
|
|
87
|
+
sudo dnf install -y fuse3
|
|
88
|
+
|
|
89
|
+
# Arch Linux
|
|
90
|
+
sudo pacman -S fuse3
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Verify both the device and unmount helper:
|
|
94
|
+
|
|
95
|
+
```sh
|
|
96
|
+
test -r /dev/fuse && test -w /dev/fuse
|
|
97
|
+
command -v fusermount3 || command -v fusermount
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
If `/dev/fuse` is missing on a normal Linux host, load the kernel module with `sudo modprobe fuse`. Containers and restricted VMs must also expose `/dev/fuse` and permit FUSE mounts; installing `fuse3` alone is not sufficient. Docker targets are not supported by `remoteFs` yet.
|
|
101
|
+
|
|
102
|
+
**macOS client (current sshx backend)**
|
|
103
|
+
|
|
104
|
+
Install the latest macFUSE release from [macfuse.io](https://macfuse.io/) (recommended by the macFUSE project) or with `brew install --cask macfuse`. The current sshx implementation uses macFUSE's kernel/VFS backend.
|
|
105
|
+
|
|
106
|
+
On Apple Silicon, first-time kernel-backend setup requires:
|
|
107
|
+
|
|
108
|
+
1. Shut down, then hold the power/Touch ID button to enter macOS Recovery.
|
|
109
|
+
2. Open Startup Security Utility, select the system volume, and choose **Reduced Security**.
|
|
110
|
+
3. Enable **Allow user management of kernel extensions from identified developers**, then restart.
|
|
111
|
+
4. In **System Settings → Privacy & Security**, allow the macFUSE system software when prompted, then restart again.
|
|
112
|
+
|
|
113
|
+
Intel Macs do not need the Startup Security Utility change, but may still require approving macFUSE in Privacy & Security and restarting. macFUSE does not require disabling SIP or Gatekeeper.
|
|
114
|
+
|
|
115
|
+
After approval, trigger a mount once and verify that macFUSE loaded:
|
|
116
|
+
|
|
117
|
+
```sh
|
|
118
|
+
ls /Library/Filesystems/macfuse.fs
|
|
119
|
+
ls /dev/macfuse*
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
**macOS 15.4+ FSKit note:** macFUSE 5 provides a userspace FSKit backend that does not require a kernel extension, Recovery-mode security changes, or a restart. It is not transparent to the current sshx mount implementation and is not enabled yet: macFUSE requires the explicit `-o backend=fskit` option, FSKit only supports mount points below `/Volumes`, and several traditional mount options are unavailable. sshx currently creates private mounts below the runtime temporary directory and supplies VFS-oriented options. Supporting FSKit therefore requires a dedicated mount-path/options adapter, although the RemoteFS wire protocol and file-operation backend can remain unchanged.
|
|
123
|
+
|
|
74
124
|
The first version guarantees workspace-relative paths only. It does not rewrite absolute command arguments, add extra mount roots, expose special files/xattrs/ACLs, or support Docker targets, FUSE-T, or FSKit. It is optimized for source trees and small files rather than large-file throughput.
|
|
75
125
|
|
|
76
126
|
### 🔌 Automatic Port Detection & Forwarding
|