ssh-agent-workspace 1.0.1 → 1.0.2

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 (2) hide show
  1. package/README.md +86 -19
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -71,11 +71,13 @@ Your agent gets a **real interactive terminal** — not one-off exec commands. I
71
71
 
72
72
  ### Install
73
73
 
74
+ npx auto-downloads and runs the latest version. Or install globally:
75
+
74
76
  ```bash
75
77
  npm install -g ssh-agent-workspace
76
78
  ```
77
79
 
78
- Or from source:
80
+ From source:
79
81
 
80
82
  ```bash
81
83
  git clone https://github.com/ShiroNexo/ssh-agent-workspace.git
@@ -121,16 +123,19 @@ Your agent now has a persistent workspace on `prod`.
121
123
 
122
124
  ### Add to Your MCP Client
123
125
 
126
+ Pick your client:
127
+
124
128
  #### OpenCode
125
129
 
126
- Add to `opencode.json`:
130
+ Add to `~/.config/opencode/opencode.json`:
127
131
 
128
132
  ```json
129
133
  {
130
- "mcpServers": {
134
+ "$schema": "https://opencode.ai/config.json",
135
+ "mcp": {
131
136
  "workspace": {
132
- "command": "node",
133
- "args": ["/path/to/ssh-agent-workspace/dist/index.js"]
137
+ "type": "local",
138
+ "command": ["npx", "-y", "ssh-agent-workspace"]
134
139
  }
135
140
  }
136
141
  }
@@ -139,23 +144,23 @@ Add to `opencode.json`:
139
144
  Or via CLI:
140
145
 
141
146
  ```bash
142
- opencode mcp add workspace -- node /path/to/ssh-agent-workspace/dist/index.js
147
+ opencode mcp add workspace -- npx -y ssh-agent-workspace
143
148
  ```
144
149
 
145
150
  #### Claude Code
146
151
 
147
152
  ```bash
148
- claude mcp add workspace -- node /path/to/ssh-agent-workspace/dist/index.js
153
+ claude mcp add workspace -- npx -y ssh-agent-workspace
149
154
  ```
150
155
 
151
- Or add to Claude Code config (`~/.config/claude-code/claude_code_config.json` or project `.mcp.json`):
156
+ Or add to `~/.config/claude-code/claude_code_config.json` or project `.mcp.json`:
152
157
 
153
158
  ```json
154
159
  {
155
160
  "mcpServers": {
156
161
  "workspace": {
157
- "command": "node",
158
- "args": ["/path/to/ssh-agent-workspace/dist/index.js"],
162
+ "command": "npx",
163
+ "args": ["-y", "ssh-agent-workspace"],
159
164
  "autoApprove": [
160
165
  "mcp__workspace__connect",
161
166
  "mcp__workspace__exec",
@@ -172,33 +177,95 @@ Or add to Claude Code config (`~/.config/claude-code/claude_code_config.json` or
172
177
  }
173
178
  ```
174
179
 
175
- **Tip:** The `autoApprove` block lets the agent use those tools without asking you for permission each time. Add or remove tools based on your comfort level.
180
+ **Tip:** The `autoApprove` block lets the agent use those tools without asking permission each time. Add or remove tools based on your comfort level.
176
181
 
177
- #### Cursor / Windsurf / Generic MCP
182
+ #### Cursor
183
+
184
+ Go to `Cursor Settings` → `MCP` → `New MCP Server`. Use this config:
178
185
 
179
186
  ```json
180
187
  {
181
188
  "mcpServers": {
182
189
  "workspace": {
183
- "command": "node",
184
- "args": ["/path/to/ssh-agent-workspace/dist/index.js"]
190
+ "command": "npx",
191
+ "args": ["-y", "ssh-agent-workspace"]
185
192
  }
186
193
  }
187
194
  }
188
195
  ```
189
196
 
190
- #### If Using npx (no global install)
197
+ #### Codex (OpenAI)
198
+
199
+ ```bash
200
+ codex mcp add workspace -- npx -y ssh-agent-workspace
201
+ ```
202
+
203
+ Or add to `~/.codex/config.toml`:
204
+
205
+ ```toml
206
+ [mcp_servers.workspace]
207
+ command = "npx"
208
+ args = ["-y", "ssh-agent-workspace"]
209
+ ```
210
+
211
+ #### Windsurf
191
212
 
192
- Replace `"command": "node"` and `"args"` with:
213
+ Add to `~/.codeium/windsurf/mcp_config.json`:
193
214
 
194
215
  ```json
195
216
  {
196
- "command": "npx",
197
- "args": ["-y", "ssh-agent-workspace"]
217
+ "mcpServers": {
218
+ "workspace": {
219
+ "command": "npx",
220
+ "args": ["-y", "ssh-agent-workspace"]
221
+ }
222
+ }
198
223
  }
199
224
  ```
200
225
 
201
- npx will download and run the latest version automatically.
226
+ #### Copilot / VS Code
227
+
228
+ ```json
229
+ {
230
+ "mcpServers": {
231
+ "workspace": {
232
+ "command": "npx",
233
+ "args": ["-y", "ssh-agent-workspace"]
234
+ }
235
+ }
236
+ }
237
+ ```
238
+
239
+ #### Gemini CLI
240
+
241
+ ```bash
242
+ gemini mcp add workspace npx -y ssh-agent-workspace
243
+ ```
244
+
245
+ #### Cline
246
+
247
+ ```json
248
+ {
249
+ "mcpServers": {
250
+ "workspace": {
251
+ "command": "npx",
252
+ "args": ["-y", "ssh-agent-workspace"]
253
+ }
254
+ }
255
+ }
256
+ ```
257
+
258
+ #### Qoder
259
+
260
+ ```bash
261
+ qodercli mcp add workspace -- npx -y ssh-agent-workspace
262
+ ```
263
+
264
+ #### Using npx
265
+
266
+ All examples above use `npx` which auto-downloads the latest version. No global install needed.
267
+
268
+ If you installed globally (`npm install -g ssh-agent-workspace`), replace `"npx"` / `"-y"` / `"ssh-agent-workspace"` with `"ssh-agent-workspace"` as the command directly.
202
269
 
203
270
  Your agent now has a persistent workspace on `prod`. Running `cd /var/www` once means the agent stays there for every subsequent command.
204
271
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ssh-agent-workspace",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Persistent SSH workspaces for AI agents. Stateful tmux-backed sessions that survive reconnects, restarts, and network drops — with runtime security and tool configuration.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",