Skip to content

Commit 7d44f68

Browse files
committed
Clarify mode to CLI mapping in README
The action's mode: check runs the full static+security pipeline (same as sklab evaluate --skip-review), not the CLI's narrower HIGH-only sklab check subcommand. Document the mapping explicitly so users don't get tripped up by the name collision.
1 parent ca8b00d commit 7d44f68

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,24 @@ and you'll get an evaluation comment.
5353
| `optimize` | judge + LLM rewrite proposal | yes | `/optimize` comment |
5454
| `apply` | writes optimized content from last comment, commits, pushes | no | `/apply-optimize` comment |
5555

56+
### Mode → CLI mapping
57+
58+
In BYOK mode the action shells out to the `sklab` CLI. The mapping is:
59+
60+
| Action `mode` | Equivalent BYOK command | Backend endpoint |
61+
|---------------|-------------------------|------------------|
62+
| `check` | `sklab evaluate --skip-review` (full 37-check static + security, no LLM) | `GET /v1/repos/:o/:r/evaluate` |
63+
| `judge` | `sklab evaluate --model <model>` (static + security + LLM rubric in one call) | `GET /evaluate` + `POST /judge` |
64+
| `optimize` | `sklab evaluate --model <model>` + `sklab optimize --model <model>` | `GET /evaluate` + `POST /judge` + `POST /optimize` |
65+
| `apply` | no CLI equivalent — parses the last sklab-action comment and commits | no backend call |
66+
67+
Note: `mode: check` is **not** `sklab check` — the CLI's `check` subcommand runs only HIGH-severity checks as a fast pre-flight. The action's `check` mode runs the full static + security pipeline, matching `sklab evaluate --skip-review`.
68+
5669
## Inputs
5770

5871
| Name | Default | Description |
5972
|------|---------|-------------|
60-
| `mode` | `check` | `check`, `judge`, `optimize`, or `apply`. Mirrors the `sklab` CLI subcommand names. |
73+
| `mode` | `check` | `check`, `judge`, `optimize`, or `apply`. See [mode → CLI mapping](#mode--cli-mapping) below. |
6174
| `fail-threshold` | `0` | Minimum static quality score (0–100) to pass. `0` = informational only. |
6275
| `security-gate` | `true` | Fail the check when the security scan returns `BLOCK`. |
6376
| `judge-threshold` | `0` | Minimum judge score (0–100) to pass. `0` = informational only. |

0 commit comments

Comments
 (0)