docs: say where the report goes when a scan is too big for the terminal - #1472
Merged
Conversation
A large sweep stops printing per-finding detail and writes the full report to a file instead. The reference said only that a path is printed on stderr — not where the file lands, how long it lasts, or that what it contains differs from what was on screen. So a reader who scrolled past that line had no way to find the report again, and no reason to expect the copy on disk to be redacted when the terminal's was not. Now stated: the bundle goes to `-d DIR` when you gave one and to a `sab-report-…` temporary directory otherwise; both `latest.md` and `latest.json` are written; the evidence there is redacted, as in any artifact on disk; `saw` never deletes the temporary copy, so it survives at the operating system's discretion; and `--json` turns the spill off because that payload already carries everything. Each of those was read off the code rather than the previous docs. Closes #1471
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
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.
A large sweep stops printing per-finding detail and writes the full report to a file instead. The reference said only that a path is printed on stderr — not where the file lands, how long it lasts, or that what it contains differs from what was on screen.
So a reader who scrolled past that line had no way to find the report again, and no reason to expect the copy on disk to be redacted when the terminal's was not.
Now documented
-d DIRDIR/latest.mdandDIR/latest.jsonsab-report-…temporary directory, printed with the reportPlus: the evidence in that file is redacted, as in any artifact on disk;
sawnever deletes the temporary copy, so it survives at the operating system's discretion rather than being cleaned up; and--jsonturns the spill off entirely, because that payload already carries every finding in full.Lives in
reference/cli/sinks.md, which is where the other destinations are described, with a pointer fromreference/cli/scan.mdwhere the behaviour is first mentioned.Verification
Every claim was read off the code, not from the previous docs:
service/run.py:320—spill = not json_out and (…), so--jsonsuppresses it, while a-dyou asked for is still writtenservice/run.py:351—tempfile.mkdtemp(prefix="sab-report-")sinks/file_sink.py:25-27—redact_payloadthenlatest.json+latest.mdThat last check caught an error in my first draft, which said
--jsonmeant no file at all — untrue when-dis also passed. Corrected before committing.Link and cross-file-anchor check clean across 51 markdown files.
Closes #1471