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
Layered on top of the v2.4.3 --exclude-paths work (#227). Fixes the
reachability-reference items #227 left:
- Document the uv + Enterprise-plan prerequisites the CLI enforces before
running reachability (exit 3), and that per-ecosystem build toolchains are
the analysis engine's runtime check, not a CLI pre-check.
- Correct --reach-min-severity values to info/low/moderate/high/critical.
- Document --reach-enable-analysis-splitting, --reach-detailed-analysis-log-file,
--reach-lazy-mode, --reach-use-only-pregenerated-sboms.
- Clarify --only-facts-file submits only the facts file when creating the full
scan (no pre-existing scan required).
- Note --reach creates a tier-1 full-application scan (scan_type=socket_tier1).
Docs-only; the 2.4.3->2.4.4 bump + uv.lock are mandated by the sync-version hook.
|`--reach`| False | False | Enable reachability analysis to identify which vulnerable functions are actually called by your code|
242
+
|`--reach`| False | False | Enable reachability analysis to identify which vulnerable functions are actually called by your code. Creates a tier-1 full-application reachability scan (`scan_type=socket_tier1`).|
242
243
|`--reach-version`| False | latest | Version of @coana-tech/cli to use for analysis |
243
244
|`--reach-analysis-timeout`| False |*coana*| Timeout in seconds for the reachability analysis. Omitted by default, so coana applies its own (currently 600s). Alias: `--reach-timeout`|
244
245
|`--reach-analysis-memory-limit`| False |*coana*| Memory limit in MB for the reachability analysis. Omitted by default, so coana applies its own (currently 8192). Alias: `--reach-memory-limit`|
245
246
|`--reach-concurrency`| False |*coana*| Control parallel analysis execution (must be >= 1). Omitted by default, so coana applies its own (currently 1) |
246
247
|`--reach-additional-params`| False || Pass custom parameters to the coana CLI tool |
247
248
|`--reach-ecosystems`| False || Comma-separated list of ecosystems to analyze (e.g., "npm,pypi"). If not specified, all supported ecosystems are analyzed |
|`--reach-use-only-pregenerated-sboms`| False | False | Build the scan only from pre-generated CycloneDX (CDX) and SPDX files in your project (requires --reach) |
251
256
|`--reach-debug`| False | False | Enable coana debug output (`--debug`) for the analysis, independent of the global `--enable-debug`|
| `--reach-output-file` | False | .socket.facts.json | Path where reachability analysis results should be saved |
254
259
| `--reach-exclude-paths` | False | | **[DEPRECATED — use `--exclude-paths`]** Comma-separated paths to exclude from reachability analysis. Still honored (unioned with `--exclude-paths`) but will be hidden in a future release |
255
-
| `--only-facts-file` | False | False | Submit only the .socket.facts.json file to an existing scan (requires --reach and a prior scan) |
260
+
| `--only-facts-file` | False | False | Submit only the .socket.facts.json file when creating the full scan (requires --reach) |
256
261
257
262
**Reachability Analysis Requirements:**
258
-
- `npm` - Required to install and run @coana-tech/cli
259
-
- `npx` - Required to execute @coana-tech/cli
263
+
264
+
The Python CLI verifies the following **up front** (before invoking the analysis engine) and exits with code **3** if any are unmet:
265
+
- `npm` - Required to install and run `@coana-tech/cli` (the analysis engine)
266
+
- `npx` - Required to execute `@coana-tech/cli`
267
+
- `uv` - Required by the analysis engine
268
+
- An **Enterprise** Socket organization plan (any `enterprise*` plan, including Enterprise trials)
269
+
270
+
Separately, the analysis engine (coana) needs the **per-ecosystem build toolchain** for whatever languages your project uses — e.g. a compatible Python interpreter (3.11+, or PyPy) for Python, a JDK for Java/Kotlin/Scala, .NET 6+ for C#, the matching Go toolchain for Go, etc. These are validated by the engine **at analysis time** (the CLI does not pre-check them) and that validation can be skipped with `--reach-disable-external-tool-checks`.
260
271
261
272
## Config file support
262
273
@@ -302,7 +313,7 @@ Sample config files:
302
313
303
314
For CI-specific examples and guidance, see [`ci-cd.md`](ci-cd.md).
304
315
305
-
The CLI will automatically install `@coana-tech/cli` if not present. Use `--reach` to enable reachability analysis during a full scan, or use `--only-facts-file` with `--reach` to submit reachability results to an existing scan.
316
+
The CLI will automatically install `@coana-tech/cli` if not present. Use `--reach` to enable reachability analysis during a full scan, or add `--only-facts-file` (with `--reach`) to submit only the reachability facts file (`.socket.facts.json`) when creating the full scan.
0 commit comments