@hahahhh/sshx 0.0.1-rc.6 → 0.0.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 +21 -31
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -74,26 +74,36 @@ sshx first tries to use the same local port as the remote listener. If that loca
|
|
|
74
74
|
|
|
75
75
|
## Installation
|
|
76
76
|
|
|
77
|
-
###
|
|
77
|
+
### Run with npx (Recommended)
|
|
78
|
+
|
|
79
|
+
No installation required — npx fetches the latest binary on each run:
|
|
78
80
|
|
|
79
81
|
```sh
|
|
80
|
-
|
|
82
|
+
npx @hahahhh/sshx@next my-server
|
|
83
|
+
npx @hahahhh/sshx@next -p 2222 user@my-server hostname
|
|
81
84
|
```
|
|
82
85
|
|
|
83
|
-
|
|
86
|
+
For repeated use, install globally:
|
|
84
87
|
|
|
85
88
|
```sh
|
|
86
|
-
|
|
87
|
-
cd sshx
|
|
88
|
-
go build -o ./bin/sshx ./cmd/sshx
|
|
89
|
+
npm install -g @hahahhh/sshx@next
|
|
89
90
|
```
|
|
90
91
|
|
|
91
|
-
|
|
92
|
+
The npm wrapper auto-downloads the correct native binary for your platform from GitHub Releases.
|
|
93
|
+
|
|
94
|
+
### Download Binary
|
|
95
|
+
|
|
96
|
+
Download the prebuilt binary directly from [GitHub Releases](https://github.com/xiaot623/sshx/releases):
|
|
92
97
|
|
|
93
98
|
```sh
|
|
94
|
-
|
|
99
|
+
# Example: macOS arm64, v0.0.1-rc.6
|
|
100
|
+
curl -L -o sshx https://github.com/xiaot623/sshx/releases/download/v0.0.1-rc.6/sshx-darwin-arm64
|
|
101
|
+
chmod +x sshx
|
|
102
|
+
sudo mv sshx /usr/local/bin/sshx
|
|
95
103
|
```
|
|
96
104
|
|
|
105
|
+
Available binaries: `sshx-darwin-arm64`, `sshx-darwin-amd64`, `sshx-linux-arm64`, `sshx-linux-amd64`.
|
|
106
|
+
|
|
97
107
|
### Shell Alias (Recommended)
|
|
98
108
|
|
|
99
109
|
Add to your `~/.bashrc` or `~/.zshrc`:
|
|
@@ -108,27 +118,7 @@ The alias is safe — unmatched hosts have zero overhead and zero side effects.
|
|
|
108
118
|
|
|
109
119
|
## Quick Start
|
|
110
120
|
|
|
111
|
-
### 1.
|
|
112
|
-
|
|
113
|
-
```sh
|
|
114
|
-
mkdir -p ~/.sshx
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
`~/.sshx/config.yaml`:
|
|
118
|
-
|
|
119
|
-
```yaml
|
|
120
|
-
features:
|
|
121
|
-
commandBridge: true
|
|
122
|
-
ports:
|
|
123
|
-
auto: true
|
|
124
|
-
domains:
|
|
125
|
-
enabled: true
|
|
126
|
-
|
|
127
|
-
commands:
|
|
128
|
-
deny: []
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
### 2. Connect normally
|
|
121
|
+
### 1. Connect normally
|
|
132
122
|
|
|
133
123
|
```sh
|
|
134
124
|
sshx my-server
|
|
@@ -138,7 +128,7 @@ sshx -p 2222 user@my-server hostname
|
|
|
138
128
|
|
|
139
129
|
All existing SSH options work — `-F`, `-o`, `-J`, `ProxyJump`, etc. are handled by OpenSSH.
|
|
140
130
|
|
|
141
|
-
###
|
|
131
|
+
### 2. Try the command bridge
|
|
142
132
|
|
|
143
133
|
Inside your SSH session on the remote:
|
|
144
134
|
|
|
@@ -147,7 +137,7 @@ sshx local uname -s
|
|
|
147
137
|
# → Darwin (your local machine's OS)
|
|
148
138
|
```
|
|
149
139
|
|
|
150
|
-
###
|
|
140
|
+
### 3. Start a dev server on the remote
|
|
151
141
|
|
|
152
142
|
On the remote, start a server listening on `localhost`:
|
|
153
143
|
|