modelos-secure 0.3.4 → 0.3.5
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 -20
- package/cli.js +12449 -12359
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,35 +8,36 @@ npx modelos-secure scan .
|
|
|
8
8
|
|
|
9
9
|
It reads the code the way an engineer would, starting where the app starts, draws the system's map and asks only what it cannot work out. Everything it decides goes into `modelos-secure.yaml`.
|
|
10
10
|
|
|
11
|
-
Before it sends anything it asks once whether a model may read the code it needs, or only an outline of it, or nothing. Every answer it sends passes a filter that takes secrets out, and settings files, keys and credentials are never
|
|
11
|
+
Before it sends anything it asks once whether a model may read the code it needs, or only an outline of it, or nothing. Every answer it sends passes a filter that takes secrets out, and settings files, keys and credentials are never sent. What leaves: the outline, the reader's answers, the map it registers, your answer key if you add one, and the last lines of the app's own output when a start fails. `.modelos-secure/sent.jsonl` lists every answer the reader sent, `--explain` shows the outline and what may and may not be read without sending anything, and `--offline` keeps everything on your machine.
|
|
12
12
|
|
|
13
13
|
At a terminal, `modelos-secure` on its own starts a session about the app in the folder: ask about it in your own words, and each answer cites the files and lines it rests on, checked against the code.
|
|
14
14
|
|
|
15
|
-
| Command | Does
|
|
16
|
-
| --------------------------------------------- |
|
|
17
|
-
| `modelos-secure` | At a terminal, a session about the app in this folder.
|
|
18
|
-
| `modelos-secure login` | Saves a workspace token, and signs in with Google if needed.
|
|
19
|
-
| `modelos-secure scan .` | Connects this repository. `--offline`, `--explain`, `--yes`.
|
|
20
|
-
| `modelos-secure review` | Starts a review of this system. `--quick`, `--ci`, `--budget`.
|
|
21
|
-
| `modelos-secure replay F-031` | Replays one finding.
|
|
22
|
-
| `modelos-secure doctor` | Checks the setup and fixes what it can.
|
|
23
|
-
| `modelos-secure runner` | Serves a review's attempts from this machine, in the app's folder. |
|
|
24
|
-
| `modelos-secure export R-1179 --format sarif` |
|
|
25
|
-
| `modelos-secure --version` | Prints this CLI's version.
|
|
15
|
+
| Command | Does |
|
|
16
|
+
| --------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
17
|
+
| `modelos-secure` | At a terminal, a session about the app in this folder. |
|
|
18
|
+
| `modelos-secure login` | Saves a workspace token, and signs in with Google if needed. |
|
|
19
|
+
| `modelos-secure scan .` | Connects this repository. `--offline`, `--explain`, `--yes`, `--ci`, `--no-review`. |
|
|
20
|
+
| `modelos-secure review` | Starts a review of this system. `--quick`, `--ci`, `--yes`, `--budget`, `--instances`. |
|
|
21
|
+
| `modelos-secure replay F-031` | Replays one finding of an app the scan connected. |
|
|
22
|
+
| `modelos-secure doctor` | Checks the setup and fixes what it can. |
|
|
23
|
+
| `modelos-secure runner` | Serves a review's attempts from this machine, in the app's folder. `--system`, `--instances`. |
|
|
24
|
+
| `modelos-secure export R-1179 --format sarif` | Prints a review's findings as SARIF or JSON; `--out` writes a file. |
|
|
25
|
+
| `modelos-secure --version` | Prints this CLI's version. |
|
|
26
26
|
|
|
27
27
|
A review of an app connected by the scan reaches it through a runner on the machine that runs it. `modelos-secure review` starts one itself, and keeps it while the review is paused; a review started from the app needs `modelos-secure runner` running in the app's folder, and says so if none is. A start command is checked before it runs and saved only once the app has started with it.
|
|
28
28
|
|
|
29
|
-
During a review,
|
|
29
|
+
During a review, the tools marked as held in `modelos-secure.yaml` are caught and never run; the scan marks every tool that can act, and a tool set to `run` runs for real. Outside a review the hooks do nothing. Requires Node 22 or newer. Python apps need Python 3.10 or newer.
|
|
30
30
|
|
|
31
31
|
Every command says what it takes with `--help`, such as `modelos-secure scan --help`, and refuses a flag it does not take.
|
|
32
32
|
|
|
33
|
-
| Exit code | Means
|
|
34
|
-
| --------- |
|
|
35
|
-
| 0 | Done.
|
|
36
|
-
| 1 | Something failed, or a fix check found a break.
|
|
37
|
-
| 2 | The command was used wrongly.
|
|
38
|
-
| 3 | There are questions only a person can answer, as `--ci` lists.
|
|
39
|
-
| 130 | Stopped with Ctrl-C. What was done is kept.
|
|
33
|
+
| Exit code | Means |
|
|
34
|
+
| --------- | ------------------------------------------------------------------------------- |
|
|
35
|
+
| 0 | Done. |
|
|
36
|
+
| 1 | Something failed, or a fix check found a break. |
|
|
37
|
+
| 2 | The command was used wrongly. |
|
|
38
|
+
| 3 | There are questions only a person can answer, as `--ci` lists. |
|
|
39
|
+
| 130 | Stopped with Ctrl-C. What was done is kept. |
|
|
40
|
+
| 143, 129 | Stopped by a signal, or the terminal closed. The app it started is stopped too. |
|
|
40
41
|
|
|
41
42
|
## Signing in
|
|
42
43
|
|