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           No output printed to stdout.
33
34       --color when
35           Control when colored output is used. Valid values:
36
37           ·  auto (default): Automatically detect if color support is
38               available on the terminal.
39
40           ·  always: Always display colors.
41
42           ·  never: Never display colors.
43
44           May also be specified with the term.color config value
45           <https://doc.rust-lang.org/cargo/reference/config.html>.
46
47   Manifest Options
48       --manifest-path path
49           Path to the Cargo.toml file. By default, Cargo searches for the
50           Cargo.toml file in the current directory or any parent directory.
51
52       --frozen, --locked
53           Either of these flags requires that the Cargo.lock file is
54           up-to-date. If the lock file is missing, or it needs to be updated,
55           Cargo will exit with an error. The --frozen flag also prevents
56           Cargo from attempting to access the network to determine if it is
57           out-of-date.
58
59           These may be used in environments where you want to assert that the
60           Cargo.lock file is up-to-date (such as a CI build) or want to avoid
61           network access.
62
63       --offline
64           Prevents Cargo from accessing the network for any reason. Without
65           this flag, Cargo will stop with an error if it needs to access the
66           network and the network is not available. With this flag, Cargo
67           will attempt to proceed without the network if possible.
68
69           Beware that this may result in different dependency resolution than
70           online mode. Cargo will restrict itself to crates that are
71           downloaded locally, even if there might be a newer version as
72           indicated in the local copy of the index. See the cargo-fetch(1)
73           command to download dependencies before going offline.
74
75           May also be specified with the net.offline config value
76           <https://doc.rust-lang.org/cargo/reference/config.html>.
77
78   Common Options
79       +toolchain
80           If Cargo has been installed with rustup, and the first argument to
81           cargo begins with +, it will be interpreted as a rustup toolchain
82           name (such as +stable or +nightly). See the rustup documentation
83           <https://rust-lang.github.io/rustup/overrides.html> for more
84           information about how toolchain overrides work.
85
86       -h, --help
87           Prints help information.
88
89       -Z flag
90           Unstable (nightly-only) flags to Cargo. Run cargo -Z help for
91           details.
92

ENVIRONMENT

94       See the reference
95       <https://doc.rust-lang.org/cargo/reference/environment-variables.html>
96       for details on environment variables that Cargo reads.
97

EXIT STATUS

99       ·  0: The workspace is OK.
100
101       ·  1: The workspace is invalid.
102

EXAMPLES

104        1. Check the current workspace for errors:
105
106               cargo verify-project
107