Skip to content

Commit f1764b4

Browse files
committed
document legal preset flag and default artifacts
Signed-off-by: lelia <2418071+lelia@users.noreply.github.com>
1 parent 02012d6 commit f1764b4

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ socketcli \
8484
| Use case | Recommended mode | Key flags |
8585
|:--|:--|:--|
8686
| Basic policy enforcement in CI | Diff-based policy check | `--strict-blocking` |
87+
| Legal/compliance artifact generation | Legal preset | `--legal` |
8788
| Reachable-focused SARIF for reporting | Full-scope grouped SARIF | `--reach --sarif-scope full --sarif-grouping alert --sarif-reachability reachable --sarif-file <path>` |
8889
| Detailed reachability export for investigations | Full-scope instance SARIF | `--reach --sarif-scope full --sarif-grouping instance --sarif-reachability all --sarif-file <path>` |
8990
| Net-new PR findings only | Diff-scope SARIF | `--reach --sarif-scope diff --sarif-reachability reachable --sarif-file <path>` |
@@ -134,6 +135,19 @@ Run:
134135
socketcli --config .socketcli.toml --target-path .
135136
```
136137

138+
Legal/compliance preset example:
139+
140+
```bash
141+
socketcli --legal --target-path .
142+
```
143+
144+
This preset enables license generation and writes default artifacts unless you override them:
145+
- `socket-report.json`
146+
- `socket-summary.txt`
147+
- `socket-report-link.txt`
148+
- `socket-sbom.json`
149+
- `socket-license.json`
150+
137151
Reference sample configs:
138152

139153
TOML:

0 commit comments

Comments
 (0)