@softpractice/softpractice-cli 0.2.2 → 0.2.3
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 +35 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -156,6 +156,7 @@ reading the evaluation.
|
|
|
156
156
|
### Configure once, from any folder
|
|
157
157
|
|
|
158
158
|
Install the CLI (see [Install](#install)), then configure your desktop client.
|
|
159
|
+
For Claude Desktop, install and open the app once before setup.
|
|
159
160
|
You do not need a lesson project yet:
|
|
160
161
|
|
|
161
162
|
```bash
|
|
@@ -164,10 +165,14 @@ softpractice mcp setup claude-desktop
|
|
|
164
165
|
softpractice mcp setup codex-desktop
|
|
165
166
|
```
|
|
166
167
|
|
|
168
|
+
After setup, quit the desktop client completely and start it again to load
|
|
169
|
+
the connection settings.
|
|
170
|
+
|
|
167
171
|
Setup registers the CLI's absolute executable path and `mcp connect` as the
|
|
168
|
-
launch arguments. It
|
|
169
|
-
|
|
170
|
-
|
|
172
|
+
launch arguments. It only updates the configuration; it does not start a
|
|
173
|
+
server or install a service that runs when the computer starts. It preserves
|
|
174
|
+
other settings and saves the previous file as `.bak`. Claude Desktop uses
|
|
175
|
+
`claude_desktop_config.json`; on Windows, setup also finds the configuration used by the Microsoft Store version. Codex uses
|
|
171
176
|
`~/.codex/config.toml` (or `$CODEX_HOME/config.toml`) and a tool timeout of
|
|
172
177
|
180 seconds. Codex Desktop, CLI, and the IDE extension share these settings.
|
|
173
178
|
No separate Codex CLI installation is needed for desktop setup.
|
|
@@ -197,18 +202,25 @@ Keep this terminal open. The server validates the Git repository and
|
|
|
197
202
|
SoftPractice project link before accepting connections. It uses the CLI's
|
|
198
203
|
saved sign-in; it never opens a sign-in flow itself.
|
|
199
204
|
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
205
|
+
On macOS, Linux, and Windows, the client automatically starts
|
|
206
|
+
`softpractice mcp connect` and communicates with it over stdio. This connection
|
|
207
|
+
process is separate from the lesson server started in your terminal. It stays
|
|
208
|
+
connected even when no lesson server is running. You can open
|
|
209
|
+
Claude Desktop or Codex Desktop before starting the lesson: tools remain
|
|
210
|
+
listed, and a lesson request explains how to start the server. Start, stop,
|
|
211
|
+
or restart the lesson server without restarting Desktop, then repeat the
|
|
212
|
+
request. Pending confirmations become invalid if the lesson server restarts.
|
|
213
|
+
No system service is installed; the client owns the connection process.
|
|
214
|
+
|
|
215
|
+
The lesson server listens on `127.0.0.1:39473`. Connections require a random
|
|
216
|
+
per-run key saved in the CLI's user configuration folder. Both processes
|
|
217
|
+
must run on the same computer under the same user and use the same
|
|
218
|
+
`SOFTPRACTICE_CONFIG_DIR` if that environment variable is set. This address
|
|
219
|
+
is not an HTTP URL.
|
|
206
220
|
|
|
207
221
|
Only one lesson server can run on this computer at a time. To switch projects,
|
|
208
|
-
stop it with Ctrl+C
|
|
209
|
-
|
|
210
|
-
repeated. If the server is offline, the bridge prints the startup command to
|
|
211
|
-
stderr and exits; start the server and reconnect.
|
|
222
|
+
stop it with Ctrl+C and start it in the other lesson folder. The next request
|
|
223
|
+
uses the new project. Setup does not need to be repeated.
|
|
212
224
|
|
|
213
225
|
### Claude Code and Codex CLI
|
|
214
226
|
|
|
@@ -226,7 +238,8 @@ and [Codex MCP documentation](https://developers.openai.com/codex/mcp).
|
|
|
226
238
|
|
|
227
239
|
`softpractice mcp` always starts the local server, including with redirected
|
|
228
240
|
stdin or in the background. Only server startup selects the project. Setup
|
|
229
|
-
|
|
241
|
+
registers the connection command and does not accept `--project`.
|
|
242
|
+
The lesson server must be running for tools to work with the lesson.
|
|
230
243
|
|
|
231
244
|
### Checking the server
|
|
232
245
|
|
|
@@ -240,14 +253,17 @@ softpractice mcp status --json
|
|
|
240
253
|
The command checks a live connection and shows the lesson folder, PID,
|
|
241
254
|
local address, and CLI version. A stopped server returns `not_running`;
|
|
242
255
|
a key file left after a crash is not treated as proof of a running server.
|
|
243
|
-
No lesson project or sign-in is needed. This reports the
|
|
244
|
-
|
|
245
|
-
|
|
256
|
+
No lesson project or sign-in is needed. This reports the lesson server,
|
|
257
|
+
not the client connection process. Lesson information is available through
|
|
258
|
+
`softpractice status` and, while the lesson server is running, the MCP
|
|
259
|
+
`status` tool.
|
|
246
260
|
|
|
247
261
|
### Stopping the server and removing the connection
|
|
248
262
|
|
|
249
|
-
Press Ctrl+C in the server's terminal to stop the lesson server. The
|
|
250
|
-
|
|
263
|
+
Press Ctrl+C in the server's terminal to stop the lesson server. The MCP
|
|
264
|
+
connection remains active, but lesson requests ask you to start the lesson
|
|
265
|
+
server. Start it again and repeat the request; no client restart is
|
|
266
|
+
needed.
|
|
251
267
|
|
|
252
268
|
To remove the client connection, run from any folder:
|
|
253
269
|
|
package/package.json
CHANGED