Skip to content

Commit 719deba

Browse files
committed
update socket scan reach description
1 parent 574ce1d commit 719deba

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

src/commands/scan/cmd-scan-reach.mts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,17 @@ const config: CliCommandConfig = {
6262
Reachability Options
6363
${getFlagListOutput(reachabilityFlags)}
6464
65+
Runs the Socket reachability analysis without creating a scan in Socket.
66+
The output is written to .socket.facts.json in the current working directory.
67+
68+
Note: Manifest files are uploaded to Socket's backend services because the
69+
reachability analysis requires creating a Software Bill of Materials (SBOM)
70+
from these files before the analysis can run.
71+
6572
Examples
6673
$ ${command}
6774
$ ${command} ./proj
75+
$ ${command} ./proj --reach-ecosystems npm,pypi
6876
`
6977
},
7078
}

src/commands/scan/cmd-scan-reach.test.mts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,17 @@ describe('socket scan reach', async () => {
3232
--reach-ecosystems List of ecosystems to conduct reachability analysis on, as either a comma separated value or as multiple flags. Defaults to all ecosystems.
3333
--reach-exclude-paths List of paths to exclude from reachability analysis, as either a comma separated value or as multiple flags.
3434
35+
Runs the Socket reachability analysis without creating a scan in Socket.
36+
The output is written to .socket.facts.json in the current working directory.
37+
38+
Note: Manifest files are uploaded to Socket's backend services because the
39+
reachability analysis requires creating a Software Bill of Materials (SBOM)
40+
from these files before the analysis can run.
41+
3542
Examples
3643
$ socket scan reach
37-
$ socket scan reach ./proj"
44+
$ socket scan reach ./proj
45+
$ socket scan reach ./proj --reach-ecosystems npm,pypi"
3846
`)
3947
expect(`\n ${stderr}`).toMatchInlineSnapshot(`
4048
"

0 commit comments

Comments
 (0)