Skip to content

Commit 41439f0

Browse files
committed
docs: show real reach-flag defaults from the Coana CLI implementation
Fill in the Default column for the flags whose defaults come from coana, verified against the @coana-tech/cli source (coana-package-manager/packages/cli): - --reach-analysis-timeout -> 600 (cli-core.ts: defaults to 600s when unset) - --reach-analysis-memory-limit -> 8192 (index.ts --memory-limit default) - --reach-concurrency -> 1 (index.ts --concurrency default) - --reach-min-severity -> info (no coana default = analyze all; info is the effective floor)
1 parent 4fcc4d7 commit 41439f0

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/cli-reference.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,12 +241,12 @@ If you don't want to provide the Socket API Token every time then you can use th
241241
|:---------------------------------|:---------|:--------|:---------------------------------------------------------------------------------------------------------------------------|
242242
| `--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`). |
243243
| `--reach-version` | False | 15.3.24 | Version of @coana-tech/cli to use. Defaults to the pinned version that ships with this CLI release, so the engine only changes when you upgrade the Socket CLI. Pass `latest` to always use the newest published version (opt-in auto-update), or an explicit version (e.g. `1.2.3`) to pin it. |
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` |
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` |
246-
| `--reach-concurrency` | False | *coana* | Control parallel analysis execution (must be >= 1). Omitted by default, so coana applies its own (currently 1) |
244+
| `--reach-analysis-timeout` | False | 600 | Timeout in seconds for the reachability analysis. Omitted by default, so coana applies its own default. Alias: `--reach-timeout` |
245+
| `--reach-analysis-memory-limit` | False | 8192 | Memory limit in MB for the reachability analysis. Omitted by default, so coana applies its own default. Alias: `--reach-memory-limit` |
246+
| `--reach-concurrency` | False | 1 | Control parallel analysis execution (must be >= 1). Omitted by default, so coana applies its own default. |
247247
| `--reach-additional-params` | False | | Pass custom parameters to the coana CLI tool |
248248
| `--reach-ecosystems` | False | | Comma-separated list of ecosystems to analyze (e.g., "npm,pypi"). If not specified, all supported ecosystems are analyzed |
249-
| `--reach-min-severity` | False | | Minimum severity level for reporting reachability results (info, low, moderate, high, critical) |
249+
| `--reach-min-severity` | False | info | Minimum severity of vulnerabilities to analyze (info, low, moderate, high, critical). Omitted by default, so coana analyzes all severities — equivalent to `info`, the lowest. |
250250
| `--reach-skip-cache` | False | False | Skip cache and force fresh reachability analysis |
251251
| `--reach-disable-analytics` | False | False | Disable analytics collection during reachability analysis |
252252
| `--reach-enable-analysis-splitting` | False | False | Enable analysis splitting/bucketing (a legacy performance feature). Splitting is disabled by default. |

0 commit comments

Comments
 (0)