Skip to content

Commit ec138e2

Browse files
committed
update README docs to include FOSSA compatibility mode
Signed-off-by: lelia <2418071+lelia@users.noreply.github.com>
1 parent b28a035 commit ec138e2

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,22 @@ This preset enables license generation and writes default artifacts unless you o
148148
- `socket-sbom.json`
149149
- `socket-license.json`
150150

151+
FOSSA-compatibility shaped legal artifacts:
152+
153+
```bash
154+
socketcli --legal-format fossa --target-path .
155+
```
156+
157+
This switches the JSON report and legal artifact payloads to FOSSA-style compatibility shapes:
158+
- the analyze artifact becomes a `project` / `vulnerability` / `licensing` / `quality` report
159+
- the SBOM artifact becomes a `project` / `dependencies` attribution-style payload
160+
161+
When `--legal-format fossa` is used without explicit output paths, the defaults are closer to the FOSSA pipeline contract:
162+
- `fossa-analyze.json`
163+
- `fossa-test.txt`
164+
- `fossa-link.txt`
165+
- `fossa-sbom.json`
166+
151167
Reference sample configs:
152168

153169
TOML:

0 commit comments

Comments
 (0)