gadriel 1.2.9 → 1.4.0

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.
Files changed (2) hide show
  1. package/README.md +63 -35
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -6,12 +6,13 @@ integrates with AI coding agents (Claude Code, Cursor, Copilot) via git hooks
6
6
  and an MCP server.
7
7
 
8
8
  > **📖 Full documentation:** **[https://gadriel.ai/docs](https://gadriel.ai/docs)**
9
- > — installation, authentication, first run, the CLI reference, supported
9
+ > — installation, first run, the CLI reference, supported
10
10
  > languages, AI-assistant integration, false-positive handling, and more.
11
11
 
12
- > **Beta program:** This release is part of the Gadriel developer beta.
13
- > Sign up at [https://app.gadriel.ai/developers/](https://app.gadriel.ai/developers/)
14
- > to get your CLI token.
12
+ > **No account required.** Install it and scan. On first run the CLI
13
+ > registers this machine anonymously (free, unlimited) — there is no signup,
14
+ > no token to paste, and no trial to expire. Signing in is optional and only
15
+ > needed to attach a scan to a team account.
15
16
 
16
17
  > **Platform support:** Linux x64/arm64 (glibc), macOS (Intel & Apple Silicon),
17
18
  > and Windows x64. The correct prebuilt binary is selected automatically at
@@ -49,21 +50,20 @@ npm `optionalDependencies`.
49
50
  ## Quick start
50
51
 
51
52
  ```bash
52
- # 1. Authenticatepaste a token from https://app.gadriel.ai/developers/tokens
53
- gadriel auth login
53
+ # 1. Scan the current repo no login, no token, no setup step.
54
+ gadriel scan .
54
55
 
55
- # 2. Scaffold code-security in your repo
56
- # Creates .security/, git hooks, MCP server config, and CLAUDE.md.
57
- # Also syncs the OSV CVE database for the languages it detects, so
58
- # your first scan has CVE detection ready (only downloads the
59
- # ecosystems your repo uses — pass --skip-osv to defer).
60
- gadriel code init
56
+ # 2. Open the HTML report
57
+ open .security/reports/index.html
58
+ ```
61
59
 
62
- # 3. Scan the current repo
63
- gadriel code scan .
60
+ Optionally scaffold the repo integration — `.security/`, git hooks, MCP
61
+ server config, and `CLAUDE.md`. This also syncs the OSV CVE database for the
62
+ ecosystems it detects, so later scans have CVE detection ready (pass
63
+ `--skip-osv` to defer):
64
64
 
65
- # 4. Open the HTML report
66
- open .security/reports/index.html
65
+ ```bash
66
+ gadriel init
67
67
  ```
68
68
 
69
69
  > **New in 1.1.5 — Multi-language SAST false-positive remediation (31-repo audit):**
@@ -116,8 +116,8 @@ open .security/reports/index.html
116
116
  > variadic-forwarder gates, web-framework-import gating for request-only
117
117
  > rules, argument-shape narrowing, test/fuzz-path down-ranking, and
118
118
  > protocol-mandated weak-crypto suppression via C/C++ caller-context.
119
- > - **Offline recovery hints** now point at `PREFLIGHT_OFFLINE=1` (the env var
120
- > that actually works) instead of a non-existent `--offline` flag.
119
+ > - **Offline recovery hints** now point at `PREFLIGHT_OFFLINE=1`. (A `--offline`
120
+ > flag on `gadriel scan` also exists in current releases.)
121
121
  >
122
122
  > **🎉 1.0.0 — General Availability.** The first stable release of the
123
123
  > Gadriel code-security CLI. Highlights across the suite:
@@ -172,7 +172,7 @@ open .security/reports/index.html
172
172
  > setups. (If you skip it, the first scan still auto-syncs on demand.)
173
173
 
174
174
  > **Manual OSV sync** is still available any time:
175
- > `gadriel code policies --osv`
175
+ > `gadriel policies --osv`
176
176
 
177
177
  ## Getting started (full guide)
178
178
 
@@ -182,22 +182,51 @@ Full onboarding guide: [https://gadriel.ai/docs](https://gadriel.ai/docs)
182
182
 
183
183
  | Command | What it does |
184
184
  |---|---|
185
- | `gadriel auth login` | Authenticate with your portal token |
186
- | `gadriel auth status` | Show current token name, expiry, and scopes |
187
- | `gadriel code init` | Scaffold `.security/`, git hooks, MCP server, `CLAUDE.md` |
188
- | `gadriel code scan` | Run SAST + SCA + secrets + config + container + API scans |
189
- | `gadriel code policies --osv` | Sync the OSV CVE vulnerability database (required once) |
190
- | `gadriel code watch` | Watch files and scan on save (Layer-1 fast path) |
191
- | `gadriel code findings` | Read findings from `.security/findings.json` |
192
- | `gadriel code fix <id>` | Confirm, dismiss, or hand a finding to an AI agent |
193
- | `gadriel code sbom` | Export an SBOM (SPDX 2.3 + CycloneDX 1.5) |
194
- | `gadriel code report` | Compliance reports + static HTML bundle + executive PDF |
195
- | `gadriel code dashboard` | Local web dashboard (binds `127.0.0.1`) |
196
- | `gadriel code mcp` | Start the MCP server for Claude Code / IDE integrations |
197
- | `gadriel code doctor --platform <p>` | Integration parity manifest for an AI-assistant platform |
185
+ | `gadriel scan` | Run SAST + SCA + secrets + config + container + API scans |
186
+ | `gadriel init` | Scaffold `.security/`, git hooks, MCP server, `CLAUDE.md` |
187
+ | `gadriel findings` | Read findings from `.security/findings.json` |
188
+ | `gadriel fix <id>` | Confirm, dismiss, or hand a finding to an AI agent |
189
+ | `gadriel policies --osv` | Sync the OSV CVE vulnerability database (optional; enables CVE detection) |
190
+ | `gadriel watch` | Watch files and scan on save (Layer-1 fast path) |
191
+ | `gadriel sbom` | Export an SBOM (SPDX 2.3 + CycloneDX 1.5) |
192
+ | `gadriel report` | Compliance reports + static HTML bundle + executive PDF |
193
+ | `gadriel verdict` | Aggregated go / no-go readiness verdict |
194
+ | `gadriel mcp` | Start the MCP server for Claude Code / IDE integrations |
195
+ | `gadriel doctor` | Diagnose configuration issues |
196
+ | `gadriel auth status` | Show this machine's credential (anonymous by default) |
197
+ | `gadriel auth login --token <t>` | *Optional* attach this machine to a team account |
198
198
 
199
199
  Output formats: `--format table|json|html|ocsf`.
200
200
 
201
+ A global `--json` works on every command that has a machine-readable mode
202
+ (`findings`, `verdict`, `skills list`, `store list`, `store status`,
203
+ `learn status`, `doctor`, `policies`, `config scoring`) and overrides that
204
+ command's own `--format`, so CI can pipe any of them without knowing which
205
+ flag each one takes:
206
+
207
+ ```bash
208
+ gadriel findings --json | jq '.findings[] | select(.severity == "high")'
209
+ gadriel verdict --json | jq -r '.verdict'
210
+ ```
211
+
212
+ `--quiet` is a separate mode and does not imply JSON. `gadriel sbom --format`
213
+ is unaffected — there `--format` selects the SBOM *standard* (SPDX vs
214
+ CycloneDX), not the encoding.
215
+
216
+ ### Re-running `init`
217
+
218
+ `init` refuses to overwrite an initialised repo unless you say how:
219
+
220
+ | Flag | Effect |
221
+ |------|--------|
222
+ | `--upgrade` | Merge new settings and templates. **Scan data is preserved** — `findings.json`, `pillar-scores.json` and `metrics/` are left alone. |
223
+ | `--add-missing` | Only add files that are absent; touch nothing that exists. |
224
+ | `--force` | Overwrite everything, **including scan results**. Use after a partial or corrupted install. |
225
+
226
+ > The older `gadriel code <verb>` spelling (e.g. `gadriel code scan`) still
227
+ > works as a hidden alias, so existing hooks and CI pipelines keep running,
228
+ > but the top-level verbs above are the current form.
229
+
201
230
  ## Scan flags
202
231
 
203
232
  | Flag | Default | Description |
@@ -212,7 +241,7 @@ Output formats: `--format table|json|html|ocsf`.
212
241
 
213
242
  ## Claude Code integration
214
243
 
215
- After `gadriel code init`, open Claude Code in your project directory:
244
+ After `gadriel init`, open Claude Code in your project directory:
216
245
 
217
246
  ```bash
218
247
  claude
@@ -234,12 +263,11 @@ Slash commands available:
234
263
  | `0` | Clean — no gate tripped |
235
264
  | `1` | Security gate tripped (`--fail-on` threshold breached) |
236
265
  | `2` | Tooling error / crash |
237
- | `7` | Auth required run `gadriel auth login` |
266
+ | `7` | Licence/entitlement check failed (reserved) |
238
267
 
239
268
  ## Documentation & support
240
269
 
241
270
  - **Full docs: https://gadriel.ai/docs**
242
- - Getting started / CLI tokens: https://app.gadriel.ai/developers/
243
271
  - Support: https://gadriel.ai/docs
244
272
 
245
273
  ## License
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gadriel",
3
- "version": "1.2.9",
3
+ "version": "1.4.0",
4
4
  "description": "Gadriel - Code-security CLI for AI-assisted development",
5
5
  "keywords": [
6
6
  "security",
@@ -17,7 +17,7 @@
17
17
  "url": "git+https://github.com/Gadriel-ai/preflight.git",
18
18
  "directory": "npm/gadriel"
19
19
  },
20
- "license": "MIT",
20
+ "license": "UNLICENSED",
21
21
  "author": "Gadriel team",
22
22
  "type": "module",
23
23
  "bin": {
@@ -34,10 +34,10 @@
34
34
  "node": ">=18"
35
35
  },
36
36
  "optionalDependencies": {
37
- "@gadriel/cli-linux-x64": "1.2.9",
38
- "@gadriel/cli-linux-arm64": "1.2.9",
39
- "@gadriel/cli-darwin-x64": "1.2.9",
40
- "@gadriel/cli-darwin-arm64": "1.2.9",
41
- "@gadriel/cli-win32-x64": "1.2.9"
37
+ "@gadriel/cli-linux-x64": "1.4.0",
38
+ "@gadriel/cli-linux-arm64": "1.4.0",
39
+ "@gadriel/cli-darwin-x64": "1.4.0",
40
+ "@gadriel/cli-darwin-arm64": "1.4.0",
41
+ "@gadriel/cli-win32-x64": "1.4.0"
42
42
  }
43
43
  }