@@ -228,6 +228,79 @@ Convert file format to plain, SPDX-Lite, CycloneDX or csv.
228
228
* - --format <format>, -f <format>
229
229
- Indicates the result output format: {plain, cyclonedx, spdxlite, csv}. (optional - default plain)
230
230
231
+ --------------------------------
232
+ Folder Scanning: folder-scan, fs
233
+ --------------------------------
234
+
235
+ Performs a comprehensive scan of a directory using folder hashing to identify components and their matches.
236
+
237
+ .. code-block :: bash
238
+
239
+ scanoss-py folder-scan < directory>
240
+
241
+ .. list-table ::
242
+ :widths: 20 30
243
+ :header-rows: 1
244
+
245
+ * - Argument
246
+ - Description
247
+ * - --output <file name>, -o <file name>
248
+ - Output result file name (optional - default STDOUT)
249
+ * - --format <format>, -f <format>
250
+ - Output format: {json} (optional - default json)
251
+ * - --timeout <seconds>, -M <seconds>
252
+ - Timeout in seconds for API communication (optional - default 600)
253
+ * - --best-match, -bm
254
+ - Enable best match mode (optional - default: False)
255
+ * - --threshold <1-100>
256
+ - Threshold for result matching (optional - default: 100)
257
+ * - --settings <file>, -st <file>
258
+ - Settings file to use for scanning (optional - default scanoss.json)
259
+ * - --skip-settings-file, -stf
260
+ - Skip default settings file (scanoss.json) if it exists
261
+ * - --key <token>, -k <token>
262
+ - SCANOSS API Key token (optional - not required for default OSSKB URL)
263
+ * - --proxy <url>
264
+ - Proxy URL to use for connections
265
+ * - --pac <file/url>
266
+ - Proxy auto configuration. Specify a file, http url or "auto"
267
+ * - --ca-cert <file>
268
+ - Alternative certificate PEM file
269
+ * - --api2url <url>
270
+ - SCANOSS gRPC API 2.0 URL (optional - default: https://api.osskb.org)
271
+ * - --grpc-proxy <url>
272
+ - GRPC Proxy URL to use for connections
273
+
274
+ --------------------------------
275
+ Folder Hashing: folder-hash, fh
276
+ --------------------------------
277
+
278
+ Generates cryptographic hashes for files in a given directory and its subdirectories.
279
+
280
+ .. code-block :: bash
281
+
282
+ scanoss-py folder-hash < directory>
283
+
284
+ .. list-table ::
285
+ :widths: 20 30
286
+ :header-rows: 1
287
+
288
+ * - Argument
289
+ - Description
290
+ * - --output <file name>, -o <file name>
291
+ - Output result file name (optional - default STDOUT)
292
+ * - --format <format>, -f <format>
293
+ - Output format: {json} (optional - default json)
294
+ * - --settings <file>, -st <file>
295
+ - Settings file to use for scanning (optional - default scanoss.json)
296
+ * - --skip-settings-file, -stf
297
+ - Skip default settings file (scanoss.json) if it exists
298
+
299
+ Both commands also support these general options:
300
+ * --debug, -d: Enable debug messages
301
+ * --trace, -t: Enable trace messages
302
+ * --quiet, -q: Enable quiet mode
303
+
231
304
-----------------
232
305
Component:
233
306
-----------------
0 commit comments