[SP-2587] chore: update documentation

Author: matiasdaloia

CLIENT_HELP.md

@@ -485,6 +485,15 @@ The new `folder-scan` subcommand performs a comprehensive scan on an entire dire
 scanoss-py folder-scan /path/to/folder -o folder-scan-results.json 
 ```
 
+**Options:**
+- `--rank-threshold`: Filter results to only show those with rank value at or below this threshold (e.g., `--rank-threshold 3` returns results with rank 1, 2, or 3). Lower rank values indicate higher quality matches.
+- `--format`: Result output format (json or cyclonedx, default: json)
+
+**Example with rank threshold:**
+```shell
+scanoss-py folder-scan /path/to/folder --rank-threshold 3 -o folder-scan-results.json
+```
+
 ### Container-Scan a Docker Image
 
 The `container-scan` subcommand allows you to scan Docker container images for dependencies. This command extracts and analyzes dependencies from container images, helping you identify open source components within containerized applications.

docs/source/index.rst

@@ -249,9 +249,11 @@ Performs a comprehensive scan of a directory using folder hashing to identify co
    * - --output <file name>, -o <file name>
      - Output result file name (optional - default STDOUT)
    * - --format <format>, -f <format>
-     - Output format: {json} (optional - default json)
+     - Output format: {json, cyclonedx} (optional - default json)
    * - --timeout <seconds>, -M <seconds>
      - Timeout in seconds for API communication (optional - default 600)
+   * - --rank-threshold <number>
+     - Filter results to only show those with rank value at or below this threshold (e.g., --rank-threshold 3 returns results with rank 1, 2, or 3). Lower rank values indicate higher quality matches.
    * - --settings <file>, -st <file>
      - Settings file to use for scanning (optional - default scanoss.json)
    * - --skip-settings-file, -stf

src/scanoss/cli.py

@@ -632,8 +632,8 @@ def setup_args() -> None:  # noqa: PLR0912, PLR0915
         '--rank-threshold',
         type=int,
         default=DEFAULT_HFH_RANK_THRESHOLD,
-        help='Get results with rank below this threshold (e.g i only want to see results from rank 5 and below). '
-        'Lower rank means better quality.',
+        help='Filter results to only show those with rank value at or below this threshold (e.g., --rank-threshold 3 returns results with rank 1, 2, or 3). '
+        'Lower rank values indicate higher quality matches.',
     )
     p_folder_scan.set_defaults(func=folder_hashing_scan)