You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ci-integration.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Turn SkillEvaluator into a merge gate for your skill repository. The recommended
16
16
|`2`| Configuration error — bad flags or an unreadable target | Fix the pipeline, not the skill |
17
17
|`3`| Runtime error — an unexpected internal failure | Re-run; the skill was never judged. File an issue if it persists |
18
18
19
-
Tier 1 checks gate the exit code — and so do Tier 2 deduplication findings when dedup runs (the recommended gate below disables it with `--no-dedup`). Tier 3 live-evaluation results are always advisory inside `validate`: they appear in the reports but never flip a passing run to `1`. That means you can layer Tier 3 on later without destabilizing the gate.
19
+
Tier 1 checks always gate the exit code. Tier 2 deduplication findings gate when dedup runs unless you pass `--no-block-on-dedup`; the recommended keyless gate below instead disables Tier 2 with `--no-dedup`. Tier 3 live-evaluation results are advisory inside `validate` unless you pass `--block-on-agent-eval`. Reports record the effective choice for each tier.
20
20
21
21
## The recommended gate
22
22
@@ -156,11 +156,11 @@ You do not have to turn on the strictest gate on day one. A path that works well
156
156
157
157
### Add LLM-backed checks
158
158
159
-
Add a provider key as a masked CI secret, set `SKILL_EVAL_LLM_PROVIDER`, then add `--llm` (and `--llm-verify` to suppress false positives) and drop `--no-dedup` so Tier 2 overlap checks run too. Note that once dedup runs, its findings gate the exit code alongside Tier 1. See [Providers & Credentials](configuration.mdx) for provider setup.
159
+
Add a provider key as a masked CI secret, set `SKILL_EVAL_LLM_PROVIDER`, then add `--llm` (and `--llm-verify` to suppress false positives) and drop `--no-dedup` so Tier 2 overlap checks run too. Once dedup runs, its findings gate alongside Tier 1 by default; add `--no-block-on-dedup` if you want evidence without enforcing it yet. See [Providers & Credentials](configuration.mdx) for provider setup.
160
160
161
161
### Add an advisory Tier 3 job
162
162
163
-
Run live agent evaluation as a separate, non-blocking job — either `skillevaluator tier3 evaluate` on its own or `validate --tier3` (`--agent-eval` is a supported compatibility alias and is not currently deprecated; `validate --full` runs Tier 1+2+3 in one shot). Tier 3 results never gate `validate`'s exit code; the standalone `tier3 evaluate` exits non-zero only when the run itself fails to complete. Expose agent credentials as CI secrets in the job environment — the `env:` block of the workflow step — because SkillEvaluator reads operator credentials from the host environment only. With the `nv_build` provider and `--env-mode docker`, a single `NVIDIA_API_KEY` secret covers the evaluator and all three agents. See [Tier 3: Live Evaluation](tier3-live-evaluation.mdx).
163
+
Run live agent evaluation as a separatejob — either `skillevaluator tier3 evaluate` on its own or `validate --tier3` (`--agent-eval` is a supported compatibility alias and is not currently deprecated; `validate --full` runs Tier 1+2+3 in one shot). Attached Tier 3 is advisory by default; add `--block-on-agent-eval` when the team is ready for its findings or invalid source evidence to fail the merge gate. The standalone `tier3 evaluate` exits non-zero when the run itself fails to complete. Expose agent credentials as CI secrets in the job environment — the `env:` block of the workflow step — because SkillEvaluator reads operator credentials from the host environment only. With the `nv_build` provider and `--env-mode docker`, a single `NVIDIA_API_KEY` secret covers the evaluator and all three agents. See [Tier 3: Live Evaluation](tier3-live-evaluation.mdx).
Validate a skill, rule, workflow, or plugin. Tier 1 static, security, and quality checks gate the exit code — and so do Tier 2 deduplication findings when that pass runs (on by default, degrading gracefully without embedding access); Tier 3 live evaluation attaches as an advisory pass when enabled with `--tier3`, `--autopilot`, `--full`, or the supported `--agent-eval` compatibility alias.
92
+
Validate a skill, rule, workflow, or plugin. Tier 1 static, security, and quality checks always gate the exit code. Tier 2 deduplication runs and gates by default, but `--no-block-on-dedup` keeps the scan while making its findings advisory. Tier 3 live evaluation attaches as an advisory pass when enabled with `--tier3`, `--autopilot`, `--full`, or the supported `--agent-eval` compatibility alias; add `--block-on-agent-eval` to make its findings gate.
@@ -136,7 +139,7 @@ Static checks; LLM-free by default. Tier 1 gates the exit code and always runs.
136
139
137
140
| Flag | Default | Effect |
138
141
| --- | --- | --- |
139
-
|`--checks, --tier1-checks TEXT`| all applicable | Comma-separated subset of Tier 1 checks. Choices: `schema`, `security`, `pii`, `license`, `code-integrity`, `unicode`, `quality`, `lint`; opt-in (not run by default):`version`,`dependency`. `quality`/`lint`/`version` are skill-only and skipped for rules and workflows. |
142
+
|`--checks, --tier1-checks TEXT`| all applicable | Comma-separated subset of Tier 1 checks. Default choices: `schema`, `version`, `security`, `pii`, `license`, `code-integrity`, `unicode`, `quality`, `lint`; opt-in (not run by default): `dependency`. `quality`/`lint`/`version` are skill-only and skipped for rules and workflows. |
140
143
|`--fail-fast`| off | Stop on the first failing check instead of collecting all issues. |
141
144
|`-c, --continue-on-failure`| off | Run the full pipeline without stopping early; record all issues in the reports. Overrides `--fail-fast`, and for folder validation keeps scanning every skill past a CRITICAL finding. |
142
145
|`--llm, --tier1-llm / --no-llm, --no-tier1-llm`|`no-llm`| Enable LLM-backed security analysis (requires a configured public provider — see [Providers & Credentials](configuration.mdx)). |
@@ -150,6 +153,7 @@ Embedding + LLM dedup; on by default, skips gracefully without a provider key.
150
153
| Flag | Default | Effect |
151
154
| --- | --- | --- |
152
155
|`--dedup, --tier2 / --no-dedup, --no-tier2`|`dedup`| Run Tier 2 intra-skill semantic-overlap checks. On by default; skipped gracefully without public embedding access. Use `--no-tier2` (or `--no-dedup`) to disable. |
156
+
|`--block-on-dedup / --no-block-on-dedup`| blocking | Choose whether Tier 2 findings participate in the `validate` exit gate. The scan and its report entries still run with `--no-block-on-dedup`. |
153
157
154
158
### Tier 3 · Live Agent Evaluation
155
159
@@ -159,7 +163,8 @@ The following flags are forwarded to the live-eval engine **only when Tier 3 is
159
163
160
164
| Flag | Default | Effect |
161
165
| --- | --- | --- |
162
-
|`--tier3, --agent-eval`| off | Also run Tier 3 live agent evaluation (requires `evals/evals.json`). Advisory: it never changes the exit code. `--tier3` is the primary name; `--agent-eval` is a supported compatibility alias and is not currently deprecated. |
166
+
|`--tier3, --agent-eval`| off | Also run Tier 3 live agent evaluation. Accepts a supported YAML/JSON dataset or native Harbor source and validates it before execution. Tier 3 is advisory by default. `--tier3` is the primary name; `--agent-eval` is a supported compatibility alias and is not currently deprecated. |
167
+
|`--block-on-agent-eval / --no-block-on-agent-eval`| advisory | Choose whether Tier 3 findings, including missing or invalid selected task-source evidence, participate in the `validate` exit gate. This flag does not enable Tier 3 by itself. |
163
168
|`--autopilot`| off | Generate an evaluation source automatically when missing, then run Tier 3 (implies `--tier3`). |
164
169
|`-a, --agents TEXT`|`codex`| Comma-separated Harbor agents to evaluate. |
165
170
|`--env-mode`|`docker`| Harbor environment backend (full list under [tier3 evaluate](#tier3-evaluate)). |
Copy file name to clipboardExpand all lines: docs/environment-variables.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,7 +79,7 @@ These variables tune the static and security checks. The check-by-check guide is
79
79
|`SKILLEVALUATOR_SKILLSPECTOR_PATH`| auto-discovered | Absolute path to the SkillSpector executable. |
80
80
|`SKILLEVALUATOR_SCHEMA_ALLOWED_DIRS`| — | Extra allowed skill-root directory names (comma- or whitespace-separated), e.g. `data,fixtures`. Additive only — names extend the built-in allowlist and never replace it. |
81
81
|`SKILLEVALUATOR_SUBMITTER`| auto-detected | Explicit submitter identity for the home-path PII check. It is combined with `GITHUB_ACTOR`, `USER`, `LOGNAME`, `USERNAME`, the OS login name, and the skill's declared author — every identity that resolves is protected. If none resolves, the home-path check is disabled with a warning. |
82
-
|`SKILLEVALUATOR_PREVIOUS_VERSION`| — | The previously published skill version that the opt-in version check (`--checks version`) compares against. |
82
+
|`SKILLEVALUATOR_PREVIOUS_VERSION`| — | The previously published skill version that the default version check compares against. Without this value or `--previous-version`, the check validates the current version's format but does not enforce an increase. |
83
83
84
84
<Warning>
85
85
The scanner path overrides fail closed: a value that is not an absolute, executable file is treated as a configuration error rather than silently falling back to another same-named binary on `PATH`. This prevents a planted executable from hijacking a security scan.
Copy file name to clipboardExpand all lines: docs/quickstart.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ Get your first evaluation result in about two minutes, with no API key. This pag
92
92
| Gate skill quality and security |`validate`|[Tier 1: Validation](tier1-validation.mdx)| Exit code `0`, no CRITICAL findings |
93
93
| Find overlapping or duplicate skills |`similarity-check`|[Tier 2: Deduplication](tier2-deduplication.mdx)| No `EXACT_DUPLICATE` or `HIGH_SIMILARITY` findings |
94
94
| Prove the skill helps a real agent |`tier3 evaluate`|[Tier 3: Live Evaluation](tier3-live-evaluation.mdx)| Positive Skill Lift across the five dimensions |
95
-
| Run all three tiers in one shot |`validate --full`|[Tier 3: Live Evaluation](tier3-live-evaluation.mdx)| Exit code `0` plus an auto-generated dataset and advisory Tier 3 results|
95
+
| Run all three tiers in one shot |`validate --full`|[Tier 3: Live Evaluation](tier3-live-evaluation.mdx)| Exit code `0` plus an auto-generated dataset; Tier 3 is advisory unless you add `--block-on-agent-eval`|
96
96
| Block bad skills at merge time |`validate` in CI |[Gate Your CI](ci-integration.mdx)| A red check on failing PRs |
97
97
| Look up every flag and default | — |[CLI Reference](cli-reference.mdx)| — |
Copy file name to clipboardExpand all lines: docs/tier1-validation.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ Tier 1 is exposed through one umbrella command and five standalone commands. Eac
19
19
|`pii-scan`| Detect PII, credentials, secrets, and local identifiers | No (only with `--llm-verify`) |
20
20
|`lint-scripts`| Run advisory AST-based checks on Python scripts | No |
21
21
22
-
`validate` is the umbrella command: Tier 1 checks gate the exit code (non-zero on failure or incomplete required scanner evidence), Tier 2 dedup runs by default and degrades gracefully without embedding access, and Tier 3 can be attached as an advisory pass with `--tier3`, `--autopilot`, `--full`, or an explicit tier selection such as `--tiers 1,3` (`--agent-eval` remains a supported compatibility alias and is not currently deprecated).
22
+
`validate` is the umbrella command: Tier 1 checks always gate the exit code (non-zero on failure or incomplete required scanner evidence), Tier 2 dedup runs and gates by default while degrading gracefully without embedding access, and Tier 3 can be attached as an advisory pass with `--tier3`, `--autopilot`, `--full`, or an explicit tier selection such as `--tiers 1,3` (`--agent-eval` remains a supported compatibility alias and is not currently deprecated). Use `--no-block-on-dedup` to keep Tier 2 advisory or `--block-on-agent-eval` to promote Tier 3 into the gate.
23
23
24
24
## Run a validation
25
25
@@ -297,7 +297,7 @@ Bundled Python scanners resolve next to the SkillEvaluator interpreter before `P
Tier 1 checks — and the Tier 2 dedup pass, when it runs — gate the exit code inside `validate`; Tier 3 findings are advisory and never change it. The `quality` check passes when the composite score reaches `--min-score` (default `70`).
300
+
Tier 1 checks always gate the exit code inside `validate`. Tier 2 gates when it runs unless `--no-block-on-dedup` is set. Tier 3 is advisory unless `--block-on-agent-eval` is set. The `quality` check passes when the composite score reaches `--min-score` (default `70`). Reports record the effective gate membership for every tier so saved evidence and process status agree.
301
301
302
302
`--fail-fast`stops after the first failed check. `-c`/`--continue-on-failure` overrides it, records the full pipeline, and keeps scanning a collection past a CRITICAL finding. Wiring these exit codes into a merge gate — including a complete GitHub Actions recipe — is covered in [Gate Your CI](ci-integration.mdx).
0 commit comments