Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

cargo-check (1)

Name

cargo-check - Check the current project

Synopsis

cargo check [OPTIONS]

Description

CARGO-CHECK(1)                   Cargo Manual                   CARGO-CHECK(1)



NAME
       cargo-check - Check the current project

SYNOPSIS
       cargo check [OPTIONS]

DESCRIPTION
       Check a local package and all of its dependencies.

       If  the --package argument is given, then SPEC is a package id specifi-
       cation which indicates which package should be checked.  If it  is  not
       given,  then  the  current package is checked.  For more information on
       SPEC and its format, see the "cargo help pkgid" command.

       Compilation can be configured via the use of profiles which are config-
       ured in the manifest.  The default profile for this command is dev, but
       passing the --release flag will use the release profile instead.

OPTIONS
       -h, --help
              Print this message.

       -p SPEC, --package SPEC ...
              Package to check.

       -j IN, --jobs IN
              Number of parallel jobs, defaults to # of CPUs.

       --lib  Check only this package's library.

       --bin NAME
              Check only the specified binary.

       --example NAME
              Check only the specified example.

       --test NAME
              Check only the specified test target.

       --bench NAME
              Check only the specified benchmark target.

       --release
              Check artifacts in release mode.

       --all-features
              Check with all available features.

       --features FEATURES
              Space-separated list of features to also check.

       --no-default-features
              Do not check the default feature.

       --target TRIPLE
              Check for the target triple.

       --manifest-path PATH
              Path to the Cargo.toml to compile.

       -v, --verbose
              Use verbose output.

       -q, --quiet
              No output printed to stdout.

       --color WHEN
              Coloring: auto, always, never.

EXAMPLES
       Check a local package and all of its dependencies

              $ cargo check

       Check a package with optimizations

              $ cargo check --release


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE    |
       +---------------+----------------------+
       |Availability   | developer/rust/cargo |
       +---------------+----------------------+
       |Stability      | Volatile             |
       +---------------+----------------------+
SEE ALSO
       cargo(1)

COPYRIGHT
       This work is dual-licensed under Apache 2.0 and MIT terms.   See  COPY-
       RIGHT file in the cargo source distribution.



NOTES
       This software was built from source available at https://github.com/or-
       acle/solaris-userland.  The original community  source  was  downloaded
       from  https://static.rust-lang.org/dist/rustc-1.28.0-src.tar.xz

       Further information about this software can be found on the open source
       community website at http://www.rust-lang.org/.



The Rust package manager           May 2016                     CARGO-CHECK(1)