ingredients-report(1)

👑 ingredients-report(1) — the group chat manual, bestie edition 💅

okay so real talk: this is a page from the General Commands Manual, and the command it's all about is ingredients-report. yes, that's a mouthful. yes, she's worth it. let's get into it 🫶

---

✨ NAME ✨

ingredients-report — compare a crate against the contents of the upstream version control system 🦋

---

🌸 SYNOPSIS 🌸

ingredients report [--format] [--severity] [-f|--file]
[-u|--with-repository] [-p|--with-path-in-vcs] [-r|--with-vcs-ref]
[-L|--diff-size-limit] [-h|--help] <NAME> <VERSION>

---

💖 DESCRIPTION 💖

Compare a crate against the contents of the upstream version control system. that's the whole vibe. she's a detective and the crate is the suspect 🔍✨

so by default? the crate archive gets downloaded from crates.io. no cap. but if you wanna override that behaviour, just pass --file <PATH> and she'll use a locally downloaded file instead. your file, your rules 💅

now, for crates that don't set package.repository in their metadata — yeah, those ones, they exist — you can hand her a URL with the --with-repository <URL> argument. problem solved, no drama 🙈

and for crates that got published with old versions of cargo that did not yet include complete .cargo_vcs_info.json files (the struggle was real back then), you've got two rescue options:

• the "path in VCS" — that's the relative path where the crate can be found in the repository — can be provided with the --with-path-in-vcs <PATH> argument
• and the VCS ref can be provided with the --with-vcs-ref <REF> argument

iconic. she's got you covered from every angle 👑

---

🎀 OPTIONS 🎀

• --format <FORMAT> — the output format, bestie. default is plain.

possible values:

• plain
• verbose
• json

• --severity <SEVERITY> — the minimum severity you wanna hear about. default is info.

possible values:

• fatal: fatal problems that prevent further processing 💀
• error: probable errors that require manual investigation 😭
• warning: potential issues that might or might not be harmless 🫠
• info: additional information provided for some situations ✨
• debug: information only useful for debugging purposes 🔧

• -f, --file <FILE> — path to a local crate archive to use instead of downloading from crates.io 🍓
• -u, --with-repository <WITH_REPOSITORY> — provide a repository URL if package.repository is missing or wrong 🌈
• -p, --with-path-in-vcs <WITH_PATH_IN_VCS> — provide "path in VCS" if .cargo_vcs_info.json is missing or incomplete 🧚
• -r, --with-vcs-ref <WITH_VCS_REF> — provide VCS ref if .cargo_vcs_info.json is missing or incomplete 💜
• -L, --diff-size-limit <DIFF_SIZE_LIMIT> — override the default file size limit (in bytes) for diff generation ⭐

pass "0" to set no file size limit — but heads up, that is not recommended. the default value is 1 MiB (1024 * 1024).

like, do you actually want her diffing a whole blu-ray? no. no you do not. 🚨

• -h, --help — print help (see a summary with '-h') 🎀
• <NAME> — name of the crate 👑
• <VERSION> — version of the crate 🌟

---

and that's the whole page, bestie. no notes. 💖

signing off from the General Commands Manual, this was the report page for ingredients-report(1) — that's the source and the version tag right there in the footer, date and all, as the man gods intended. slay, go diff some crates, periodt. 💅✨