Skip to content

docs: How to transition from osv-scalibr to osv-scanner#2173

Merged
another-rex merged 8 commits into
google:mainfrom
another-rex:scalibr-to-scanner-doc
Aug 19, 2025
Merged

docs: How to transition from osv-scalibr to osv-scanner#2173
another-rex merged 8 commits into
google:mainfrom
another-rex:scalibr-to-scanner-doc

Conversation

@another-rex
Copy link
Copy Markdown
Collaborator

Add doc describing how to transition from osv-scalibr to osv-scanner.

| `--root` | `[directory]` (argument) | `osv-scanner scan source [directory]` |
| `--result` | `--output` | `osv-scanner --output <file>` |
| `-o` | `--format` and `--output` | e.g. `osv-scalibr -o spdx23-json=r.json` becomes `osv-scanner --format spdx-2.3-json --output r.json` |
| `--plugins` | `--experimental-plugins` | |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to list some example plugins/extractors/detectors here?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made google/osv-scalibr#1137 which I'll link to on this doc for the list of plugins available.

Comment thread docs/migrating-from-scalibr.md Outdated
**osv-scalibr:**

```sh
scalibr --root /path/to/your/project
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember you need to specify the output file in CLI as well?

osv-scanner /path/to/your/project
```

### Selecting plugins
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

though covered in manual-plugin-selection.md, it might be worth mentioning where to find the list of available plugins; also the list of plugins may be scoped to the ones in the scalibr version that we depend on.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Aug 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.40%. Comparing base (6f95142) to head (05c3123).
⚠️ Report is 24 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2173      +/-   ##
==========================================
+ Coverage   67.34%   67.40%   +0.05%     
==========================================
  Files         169      170       +1     
  Lines       16282    16362      +80     
==========================================
+ Hits        10965    11028      +63     
- Misses       4634     4635       +1     
- Partials      683      699      +16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@another-rex another-rex merged commit 4c2930a into google:main Aug 19, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants