You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli-reference.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -702,15 +702,22 @@ All alert types are included in the GitLab report if they're marked as `error` o
702
702
703
703
### Report Schema
704
704
705
-
Socket CLI generates reports compliant with [GitLab Dependency Scanning schema version 15.0.0](https://docs.gitlab.com/ee/development/integrations/secure.html). The reports include:
705
+
Socket CLI generates reports compliant with [GitLab Dependency Scanning schema version 15.0.0](https://gitlab.com/gitlab-org/security-products/security-report-schemas/-/blob/v15.0.0/dist/dependency-scanning-report-format.json). The reports include:
706
706
707
-
- **Scan metadata**: Analyzer and scanner information
707
+
- **Scan metadata**: Analyzer and scanner information with ISO 8601 timestamps
708
708
- **Vulnerabilities**: Detailed vulnerability data with:
709
709
- Unique deterministic UUIDs for tracking
710
710
- Package location and dependency information
711
711
- Severity levels mapped from Socket's analysis
712
712
- Socket-specific alert types and CVE identifiers
713
713
- Links to Socket.dev for detailed analysis
714
+
- **Dependency files**: Manifest files and their dependencies discovered during the scan
715
+
716
+
**Schema compatibility:** The v15.0.0 schema is supported across all GitLab versions 12.0+ (both self-hosted and cloud). The report includes the `dependency_files` field, which is required by v15.0.0 and accepted as an optional extra by newer schema versions, ensuring maximum compatibility across GitLab instances.
717
+
718
+
### Performance Notes
719
+
720
+
When `--enable-gitlab-security` (or `--enable-json` / `--enable-sarif`) is used with a full scan (non-diff mode), the CLI fetches package and alert data from the scan results to populate the report. This adds time proportional to the number of packages in the scan. Without these output flags, no additional data is fetched and scan performance is unchanged.
714
721
715
722
### Requirements
716
723
@@ -726,7 +733,8 @@ Socket CLI generates reports compliant with [GitLab Dependency Scanning schema v
726
733
- Ensure the report file follows the correct schema format
727
734
728
735
**Empty vulnerabilities array:**
729
-
- This is normal if no new security issues were detected
736
+
- This is normal if no new security issues were detected in diff mode
737
+
- For full scans, ensure you are using `--enable-gitlab-security` so alert data is fetched
730
738
- Check Socket.dev dashboard for full analysis details
0 commit comments