Skip to content

Commit 8c7731c

Browse files
authored
Merge pull request #88 from sonukapoor/feature/issue-87-readme-sync-benchmark
[Docs] Add advisory sync benchmark note to README
2 parents 6528e03 + 2632ffc commit 8c7731c

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,8 @@ Sync the local advisory database:
269269
cve-lite advisories sync
270270
```
271271

272+
In our local benchmark on the same machine, syncing the OSV npm dump with about `217,065` advisory records improved from `87.53s` to `8.84s` after bulk SQLite ingestion optimizations, or about `9.9x` faster end-to-end. Results will vary by machine and network conditions.
273+
272274
Write the advisory database to a specific path:
273275

274276
```bash
@@ -305,17 +307,15 @@ cve-lite . --osv-url https://security.company.internal/osv
305307

306308
The local advisory DB is only as current as the last successful sync.
307309

308-
For now, the recommended model is:
310+
Offline scans now report advisory DB freshness and warn when the local DB appears stale or is missing sync metadata.
311+
312+
The recommended model is:
309313

310314
- sync the advisory DB on a schedule using cron, CI, or another automation system
311315
- distribute the refreshed DB where needed
312316
- run offline scans against that updated DB
313317

314-
A future improvement is to add built-in advisory DB freshness metadata, such as:
315-
316-
- last sync timestamp reporting
317-
- a TTL-style warning when the DB is older than a recommended threshold
318-
- clearer CLI guidance when a local advisory DB should be refreshed
318+
This helps keep offline scan results current without requiring developers to manually track advisory update cadence.
319319

320320
## Detecting malicious package incidents
321321

0 commit comments

Comments
 (0)