noseyparker-report(1)

📦 version 0.24.0, in nixos 26.05, nixpkgs unstable

💖 noseyparker-report — like, the whole ✨vibe✨ of "show me what you found"

okay so bestie, this is noseyparker-report, one of the pages in the General Commands Manual set. If noseyparker is the main character, this little icon is the one who walks in and goes "here's everything, in detail" — it reports your detailed scan findings. 🎀

✨ NAME ✨

noseyparker-report — report detailed scan findings. that's it. that's the whole job. 💅

🦋 SYNOPSIS 🦋

noseyparker report [-d|--datastore] [--max-matches] [--max-provenance]
[--min-score] [--finding-status] [--suppress-redundant] [-o|--output]
[-f|--format] [-v|--verbose]... [-q|--quiet] [--color] [--progress]
[--ignore-certs] [--rlimit-nofile] [--sqlite-cache-size]
[--enable-backtraces] [-h|--help]

like, yes, it's a lot of brackets. it's giving "options menu at a boba shop." 🧋 but every single one is a real thing, promise.

🌸 DESCRIPTION 🌸

Report detailed scan findings. 🫶 lowkey that's the whole description, so let's get into the good part.

💜 OPTIONS 💜

  • -d, --datastore=PATH — use the specified datastore. default is datastore.np. you can also set this with the NP_DATASTORE environment variable, so like, pick your fighter. 🌈
  • -h, --help — print help. ngl, if you add -h you get the summary version of the help (-h with a summary, fr fr).

🍓 FILTERING OPTIONS 🍓

this is the section where you go "actually, only show me the good stuff." 💅

  • --max-matches=N — limit the number of matches per finding to at most N. default is 3. a non-positive value means "no limit" — go off, no cap. 🔥
  • --max-provenance=N — limit the number of provenance entries per match to at most N. default is 3. a non-positive value means "no limit". same energy, different knob. 💜
  • --min-score=SCORE — only report findings that have a mean score of at least N. default is 0.05. scores are floating point numbers in the range [0, 1]. use the value 0 to disable this filtering entirely. important, bestie: findings that do not have a score computed will be included regardless of this setting. 🫶
  • --finding-status=STATUS — include only findings with the assigned status. the possible values are:
    • accept: findings with accept matches
    • reject: findings with reject matches
    • mixed: findings with both accept and reject matches
    • null: findings without any accept or reject matches
  • --suppress-redundant=BOOL — suppress redundant matches and findings. default is true. a match is considered redundant to another if they overlap significantly within the same blob and satisfy a handful of heuristics. (heuristics, iykyk.) possible values are true and false. ✨

🎀 OUTPUT OPTIONS 🎀

where does the tea get spilled, and in what format? 👑

  • -o, --output=PATH — write output to the specified path. if this argument is not provided, stdout will be used. so like, it'll just spill right into your terminal, iconic behavior. 🫶
  • -f, --format=FORMAT — write output in the specified format. default is human. the possible values are:
    • human: a text-based format designed for humans (hi, that's you 💖)
    • json: pretty-printed JSON format
    • jsonl: JSON Lines format
    • sarif: SARIF format (experimental 👀 — it said experimental, not me)

🌈 GLOBAL OPTIONS 🌈

  • -v, --verbose — enable verbose output. this can be repeated up to 3 times to enable successively more output. yes bestie, you can stack it, -v -v -v. 📚
  • -q, --quiet — suppress non-error feedback messages. this silences WARNING, INFO, DEBUG, and TRACE messages and disables progress bars. this overrides any provided verbosity and progress reporting options. it's giving "shhh, i'm concentrating." 🤫
  • --color=MODE — enable or disable colored output. default is auto. when this is auto, colors are enabled for stdout and stderr when they are terminals. if the NO_COLOR environment variable is set, it takes precedence and is equivalent to --color=never. possible values: auto, never, always. 🎨
  • --progress=MODE — enable or disable progress bars. default is auto. when this is auto, progress bars are enabled when stderr is a terminal. possible values: auto, never, always. ⏳
  • --ignore-certs — ignore validation of TLS certificates. ⚠️ like, that's literally what it says: it turns off certificate validation, so be careful where you point it, okay?

🧚 ADVANCED GLOBAL OPTIONS 🧚

you probably don't need these unless something goes feral. 🙈

  • --rlimit-nofile=LIMIT — set the rlimit for number of open files to LIMIT. default is 16384. this should not need to be changed from the default unless you run into crashes from running out of file descriptors. (file descriptor crashes are so not the vibe. 💀)
  • --sqlite-cache-size=SIZE — set the cache size for SQLite connections to SIZE. default is -1048576. this has the effect of setting SQLite's pragma cache_size=SIZE. the default value is set to use a maximum of 1GiB for database cache. see <https://sqlite.org/pragma.html#pragma_cache_size> for more details. 📦
  • --enable-backtraces=BOOL — enable or disable backtraces on panic. default is true. this has the effect of setting the RUST_BACKTRACE environment variable to 1. possible values: true, false. 🦀
real talk for one sec: -q overrides your verbosity and progress options, and NO_COLOR beats --color=auto. those are the facts, i'm just delivering them with glitter. 💅✨

okay bye bestie!! 🫶 this page lives in the General Commands Manual and its footer tags it as report / noseyparker-report(1) — that's the source and the manual name, right there at the bottom like a little signature. 🎀 go report something iconic. 👑🌈⭐

📦 where this page comes from