ingredients-report(1)

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

By default, the crate archive is downloaded from crates.io. To override this behaviour, pass `--file <PATH>` to use a locally downloaded file instead.

For crates that don't set `package.repository` in their metadata, a URL can be provided with the `--with-repository <URL>` argument.

For crates that have been published with old versions of cargo that did not yet include complete `.cargo_vcs_info.json` files, the "path in VCS" (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.

OPTIONS

--format <FORMAT> [default: plain]
    Output format
    [possible values: plain, verbose, json]

--severity <SEVERITY> [default: info]
    Minimum severity
    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 local crate archive to use instead of downloading from crates.io

-u, --with-repository <WITH_REPOSITORY>
    Provide 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 default file size limit (in bytes) for diff generation Pass "0" to set no file size limit (not recommended). The default value is 1 MiB (1024 * 1024).

-h, --help
    Print help (see a summary with '-h')

<NAME>
    Name of the crate

<VERSION>
    Version of the crate