@softpractice/softpractice-cli 0.2.2 → 0.2.4
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 +42 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -120,6 +120,13 @@ softpractice set auto-checks true
|
|
|
120
120
|
run. Unlike `softpractice check`, submission checks require a clean working
|
|
121
121
|
tree and run in an isolated snapshot of `HEAD`.
|
|
122
122
|
|
|
123
|
+
|
|
124
|
+
Lessons can declare historical data needed by their checks. The CLI downloads
|
|
125
|
+
and validates those inputs from your own workspace before starting the checks;
|
|
126
|
+
these runs require a network connection. Historical inputs are temporary and
|
|
127
|
+
never enter your project or submission. If the workspace advances during the
|
|
128
|
+
check, update the project and retry.
|
|
129
|
+
|
|
123
130
|
## Reviewer questions
|
|
124
131
|
|
|
125
132
|
When the reviewer asks questions about your solution, `softpractice result`
|
|
@@ -156,6 +163,7 @@ reading the evaluation.
|
|
|
156
163
|
### Configure once, from any folder
|
|
157
164
|
|
|
158
165
|
Install the CLI (see [Install](#install)), then configure your desktop client.
|
|
166
|
+
For Claude Desktop, install and open the app once before setup.
|
|
159
167
|
You do not need a lesson project yet:
|
|
160
168
|
|
|
161
169
|
```bash
|
|
@@ -164,10 +172,14 @@ softpractice mcp setup claude-desktop
|
|
|
164
172
|
softpractice mcp setup codex-desktop
|
|
165
173
|
```
|
|
166
174
|
|
|
175
|
+
After setup, quit the desktop client completely and start it again to load
|
|
176
|
+
the connection settings.
|
|
177
|
+
|
|
167
178
|
Setup registers the CLI's absolute executable path and `mcp connect` as the
|
|
168
|
-
launch arguments. It
|
|
169
|
-
|
|
170
|
-
|
|
179
|
+
launch arguments. It only updates the configuration; it does not start a
|
|
180
|
+
server or install a service that runs when the computer starts. It preserves
|
|
181
|
+
other settings and saves the previous file as `.bak`. Claude Desktop uses
|
|
182
|
+
`claude_desktop_config.json`; on Windows, setup also finds the configuration used by the Microsoft Store version. Codex uses
|
|
171
183
|
`~/.codex/config.toml` (or `$CODEX_HOME/config.toml`) and a tool timeout of
|
|
172
184
|
180 seconds. Codex Desktop, CLI, and the IDE extension share these settings.
|
|
173
185
|
No separate Codex CLI installation is needed for desktop setup.
|
|
@@ -197,18 +209,25 @@ Keep this terminal open. The server validates the Git repository and
|
|
|
197
209
|
SoftPractice project link before accepting connections. It uses the CLI's
|
|
198
210
|
saved sign-in; it never opens a sign-in flow itself.
|
|
199
211
|
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
212
|
+
On macOS, Linux, and Windows, the client automatically starts
|
|
213
|
+
`softpractice mcp connect` and communicates with it over stdio. This connection
|
|
214
|
+
process is separate from the lesson server started in your terminal. It stays
|
|
215
|
+
connected even when no lesson server is running. You can open
|
|
216
|
+
Claude Desktop or Codex Desktop before starting the lesson: tools remain
|
|
217
|
+
listed, and a lesson request explains how to start the server. Start, stop,
|
|
218
|
+
or restart the lesson server without restarting Desktop, then repeat the
|
|
219
|
+
request. Pending confirmations become invalid if the lesson server restarts.
|
|
220
|
+
No system service is installed; the client owns the connection process.
|
|
221
|
+
|
|
222
|
+
The lesson server listens on `127.0.0.1:39473`. Connections require a random
|
|
223
|
+
per-run key saved in the CLI's user configuration folder. Both processes
|
|
224
|
+
must run on the same computer under the same user and use the same
|
|
225
|
+
`SOFTPRACTICE_CONFIG_DIR` if that environment variable is set. This address
|
|
226
|
+
is not an HTTP URL.
|
|
206
227
|
|
|
207
228
|
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.
|
|
229
|
+
stop it with Ctrl+C and start it in the other lesson folder. The next request
|
|
230
|
+
uses the new project. Setup does not need to be repeated.
|
|
212
231
|
|
|
213
232
|
### Claude Code and Codex CLI
|
|
214
233
|
|
|
@@ -226,7 +245,8 @@ and [Codex MCP documentation](https://developers.openai.com/codex/mcp).
|
|
|
226
245
|
|
|
227
246
|
`softpractice mcp` always starts the local server, including with redirected
|
|
228
247
|
stdin or in the background. Only server startup selects the project. Setup
|
|
229
|
-
|
|
248
|
+
registers the connection command and does not accept `--project`.
|
|
249
|
+
The lesson server must be running for tools to work with the lesson.
|
|
230
250
|
|
|
231
251
|
### Checking the server
|
|
232
252
|
|
|
@@ -240,14 +260,17 @@ softpractice mcp status --json
|
|
|
240
260
|
The command checks a live connection and shows the lesson folder, PID,
|
|
241
261
|
local address, and CLI version. A stopped server returns `not_running`;
|
|
242
262
|
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
|
-
|
|
263
|
+
No lesson project or sign-in is needed. This reports the lesson server,
|
|
264
|
+
not the client connection process. Lesson information is available through
|
|
265
|
+
`softpractice status` and, while the lesson server is running, the MCP
|
|
266
|
+
`status` tool.
|
|
246
267
|
|
|
247
268
|
### Stopping the server and removing the connection
|
|
248
269
|
|
|
249
|
-
Press Ctrl+C in the server's terminal to stop the lesson server. The
|
|
250
|
-
|
|
270
|
+
Press Ctrl+C in the server's terminal to stop the lesson server. The MCP
|
|
271
|
+
connection remains active, but lesson requests ask you to start the lesson
|
|
272
|
+
server. Start it again and repeat the request; no client restart is
|
|
273
|
+
needed.
|
|
251
274
|
|
|
252
275
|
To remove the client connection, run from any folder:
|
|
253
276
|
|
package/package.json
CHANGED