noseyparker-summarize(1)

okay so bestie, welcome to the noseyparker-summarize(1) page from the General Commands Manual — this is the main-character page for noseyparker summarize, and it's literally all about summarizing scan findings. 💖

💖 NAME 💖

noseyparker-summarize — Summarize scan findings. periodt.

🦋 SYNOPSIS 🦋

noseyparker summarize [-d|--datastore] [-o|--output] [-f|--format]
[-v|--verbose]... [-q|--quiet] [--color] [--progress] [--ignore-certs]
[--rlimit-nofile] [--sqlite-cache-size] [--enable-backtraces]
[-h|--help]

✨ DESCRIPTION ✨

Findings get summarized in tabular form, and the default human format prints a table of findings with one row for each rule that produced findings. The table has several columns, bestie — it's giving organized:

• Rule: the name of the rule
• Findings: the number of findings, i.e., the number of distinct match group values produced by the rule
• Matches: the number of individual matches
• Accepted: the number of findings whose matches have accept status
• Rejected: the number of findings whose matches have reject status
• Mixed: the number of findings whose matches have a mix of accept and reject status
• Unlabeled: the number of findings whose matches have no status at all

🎀 OPTIONS 🎀

okay so here are the flags, no cap:

• -d, --datastore=PATH [default: datastore.np] — Use the specified datastore. May also be specified with the NP_DATASTORE environment variable.
• -h, --help — Print help (see a summary with -h).

🌸 OUTPUT OPTIONS 🌸

• -o, --output=PATH — Write output to the specified path. If this argument is not provided, stdout will be used.
• -f, --format=FORMAT [default: human] — Write output in the specified format. Possible values:
  • human: A text-based format designed for humans
  • json: Pretty-printed JSON format
  • jsonl: JSON Lines format

🔥 GLOBAL OPTIONS 🔥

• -v, --verbose — Enable verbose output. This can be repeated up to 3 times to enable successively more output.
• -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.
• --color=MODE [default: auto] — Enable or disable colored output. 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 [default: auto] — Enable or disable progress bars. 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.

👑 ADVANCED GLOBAL OPTIONS 👑

• --rlimit-nofile=LIMIT [default: 16384] — Set the rlimit for number of open files to LIMIT. This should not need to be changed from the default unless you run into crashes from running out of file descriptors.
• --sqlite-cache-size=SIZE [default: -1048576] — Set the cache size for SQLite connections to SIZE. 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 [default: true] — Enable or disable backtraces on panic. This has the effect of setting the RUST_BACKTRACE environment variable to 1. possible values: true, false.

💌 Cute sign-off: the footer in this copy only gives us summarize and noseyparker-summarize(1) — no extra source/version or date line appeared, so that's the whole footer vibe, bestie. Bye and slay your summaries! 🫶