@@ -259,6 +259,50 @@ Multiple Headers: You can specify any number of custom headers by repeating the
259259scanoss-py scan src -hdr " x-api-key:12345" -hdr " Authorization: Bearer <access_token>"
260260```
261261
262+ ### Scan with Snippet Tuning Options
263+ The following flags allow you to fine-tune snippet matching behavior during scanning:
264+
265+ #### Set minimum snippet hits
266+ Require at least 5 snippet hits for a match. A value of 0 defers to server configuration:
267+ ``` bash
268+ scanoss-py scan -o scan-results.json --min-snippet-hits 5 src
269+ ```
270+
271+ #### Set minimum snippet lines
272+ Require at least 3 snippet lines for a match. A value of 0 defers to server configuration:
273+ ``` bash
274+ scanoss-py scan -o scan-results.json --min-snippet-lines 3 src
275+ ```
276+
277+ #### Enable or disable ranking
278+ Enable ranking to prioritize results:
279+ ``` bash
280+ scanoss-py scan -o scan-results.json --ranking true src
281+ ```
282+ Disable ranking:
283+ ``` bash
284+ scanoss-py scan -o scan-results.json --ranking false src
285+ ```
286+
287+ #### Set ranking threshold
288+ Set the ranking threshold to 50 (valid range: 0-99). A value of -1 defers to server configuration:
289+ ``` bash
290+ scanoss-py scan -o scan-results.json --ranking-threshold=50 src
291+ ```
292+ Note: Use ` = ` syntax for negative values: ` --ranking-threshold=-1 `
293+
294+ #### Honour file extensions
295+ Control whether file extensions are considered during matching:
296+ ``` bash
297+ scanoss-py scan -o scan-results.json --honour-file-exts true src
298+ ```
299+
300+ #### Combine multiple tuning options
301+ You can combine multiple tuning options in a single scan:
302+ ``` bash
303+ scanoss-py scan -o scan-results.json --min-snippet-hits 5 --min-snippet-lines 3 --ranking true --ranking-threshold=75 src
304+ ```
305+
262306### Converting RAW results into other formats
263307The following command provides the capability to convert the RAW scan results from a SCANOSS scan into multiple different formats, including CycloneDX, SPDX Lite, CSV and GitLab Code Quality Report.
264308For the full set of formats, please run:
0 commit comments