docs: correct remaining reachability CLI reference gaps (v2.4.6)#228
Merged
Conversation
Martin Torp (mtorp)
had a problem deploying
to
socket-firewall
GitHub Actions
Error
Martin Torp (mtorp)
force-pushed
the
martin/cli-docs-update
branch
from
34c6e3f to
3244e7c
Compare
Martin Torp (mtorp)
had a problem deploying
to
socket-firewall
GitHub Actions
Error
|
🚀 Preview package published! Install with: pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==2.4.6.dev2Docker image: |
Martin Torp (mtorp)
force-pushed
the
martin/cli-docs-update
branch
from
3244e7c to
4f3d676
Compare
Martin Torp (mtorp)
had a problem deploying
to
socket-firewall
GitHub Actions
Failure
Martin Torp (mtorp)
temporarily deployed
to
socket-firewall
GitHub Actions
Inactive
Reachability-reference fixes layered on current main (v2.4.5): - 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 version bump + uv.lock are mandated by the sync-version hook.
Martin Torp (mtorp)
force-pushed
the
martin/cli-docs-update
branch
from
4f3d676 to
7151c3f
Compare
Martin Torp (mtorp)
temporarily deployed
to
socket-firewall
GitHub Actions
Inactive
Martin Torp (mtorp)
changed the title
Benjamin Barslev Nielsen (barslev)
approved these changes
Jun 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Layers the remaining Python CLI reachability reference corrections onto current
main(v2.4.5 → 2.4.6), bringing the reachability documentation in line with the current implementation. Keeps the stable#reachability-analysisanchor indocs/cli-reference.md.The headline reachability flag work already landed on
mainseparately — #226 (canonical--reach-analysis-timeout/--reach-analysis-memory-limitnames, coana-delegated defaults) and #227 (unified--exclude-paths, deprecate--reach-exclude-paths). This PR fixes only what those left stale or missing indocs/cli-reference.md.Changes (
docs/cli-reference.md)uv+ Enterprise-plan prerequisites the CLI enforces before running reachability (exits with code 3 if unmet), and clarify that per-ecosystem build toolchains (JDK / .NET / Go / a compatible Python interpreter) are checked by the analysis engine at runtime, not pre-checked by the CLI.--reach-min-severity— corrected the documented values toinfo, low, moderate, high, critical(was the inaccuratelow, medium, high, critical).--reach-enable-analysis-splitting,--reach-detailed-analysis-log-file,--reach-lazy-mode,--reach-use-only-pregenerated-sboms.--only-facts-file— fixed misleading wording (submits only the facts file when creating the full scan; no pre-existing scan required).--reach— noted it creates a tier-1 full-application scan (scan_type=socket_tier1).Other files (tooling churn, no code changes)
CHANGELOG.md—2.4.6entry (docs-only).socketsecurity/__init__.py,pyproject.toml,uv.lock— patch bump2.4.5 → 2.4.6, mandated by the repo'ssync-versionpre-commit hook (every commit forces a patch bump + lockfile refresh).Notes
--exclude-pathsin both CLIs).