cargo-verify-project(1)

1CARGO-VERIFY-PROJECT(1)     General Commands Manual    CARGO-VERIFY-PROJECT(1)
2
3
4

NAME

6       cargo-verify-project — Check correctness of crate manifest
7

SYNOPSIS

9       cargo verify-project [options]
10

DESCRIPTION

12       This command will parse the local manifest and check its validity. It
13       emits a JSON object with the result. A successful validation will
14       display:
15
16           {"success":"true"}
17
18       An invalid workspace will display:
19
20           {"invalid":"human-readable error message"}
21

OPTIONS

23   Display Options
24       -v, --verbose
25           Use verbose output. May be specified twice for “very verbose”
26           output which includes extra output such as dependency warnings and
27           build script output. May also be specified with the term.verbose
28           config value
29           <https://doc.rust-lang.org/cargo/reference/config.html>.
30
31       -q, --quiet
32           Do not print cargo log messages. May also be specified with the
33           term.quiet config value
34           <https://doc.rust-lang.org/cargo/reference/config.html>.
35
36       --color when
37           Control when colored output is used. Valid values:
38
39           •  auto (default): Automatically detect if color support is
40               available on the terminal.
41
42           •  always: Always display colors.
43
44           •  never: Never display colors.
45
46           May also be specified with the term.color config value
47           <https://doc.rust-lang.org/cargo/reference/config.html>.
48
49   Manifest Options
50       --manifest-path path
51           Path to the Cargo.toml file. By default, Cargo searches for the
52           Cargo.toml file in the current directory or any parent directory.
53
54       --frozen, --locked
55           Either of these flags requires that the Cargo.lock file is
56           up-to-date. If the lock file is missing, or it needs to be updated,
57           Cargo will exit with an error. The --frozen flag also prevents
58           Cargo from attempting to access the network to determine if it is
59           out-of-date.
60
61           These may be used in environments where you want to assert that the
62           Cargo.lock file is up-to-date (such as a CI build) or want to avoid
63           network access.
64
65       --offline
66           Prevents Cargo from accessing the network for any reason. Without
67           this flag, Cargo will stop with an error if it needs to access the
68           network and the network is not available. With this flag, Cargo
69           will attempt to proceed without the network if possible.
70
71           Beware that this may result in different dependency resolution than
72           online mode. Cargo will restrict itself to crates that are
73           downloaded locally, even if there might be a newer version as
74           indicated in the local copy of the index. See the cargo-fetch(1)
75           command to download dependencies before going offline.
76
77           May also be specified with the net.offline config value
78           <https://doc.rust-lang.org/cargo/reference/config.html>.
79
80   Common Options
81       +toolchain
82           If Cargo has been installed with rustup, and the first argument to
83           cargo begins with +, it will be interpreted as a rustup toolchain
84           name (such as +stable or +nightly). See the rustup documentation
85           <https://rust-lang.github.io/rustup/overrides.html> for more
86           information about how toolchain overrides work.
87
88       --config KEY=VALUE or PATH
89           Overrides a Cargo configuration value. The argument should be in
90           TOML syntax of KEY=VALUE, or provided as a path to an extra
91           configuration file. This flag may be specified multiple times. See
92           the command-line overrides section
93           <https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides>
94           for more information.
95
96       -C PATH
97           Changes the current working directory before executing any
98           specified operations. This affects things like where cargo looks by
99           default for the project manifest (Cargo.toml), as well as the
100           directories searched for discovering .cargo/config.toml, for
101           example. This option must appear before the command name, for
102           example cargo -C path/to/my-project build.
103
104           This option is only available on the nightly channel
105           <https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> and
106           requires the -Z unstable-options flag to enable (see #10098
107           <https://github.com/rust-lang/cargo/issues/10098>).
108
109       -h, --help
110           Prints help information.
111
112       -Z flag
113           Unstable (nightly-only) flags to Cargo. Run cargo -Z help for
114           details.
115

ENVIRONMENT

117       See the reference
118       <https://doc.rust-lang.org/cargo/reference/environment-variables.html>
119       for details on environment variables that Cargo reads.
120

EXIT STATUS

122       •  0: The workspace is OK.
123
124       •  1: The workspace is invalid.
125

EXAMPLES

127        1. Check the current workspace for errors:
128
129               cargo verify-project
130