logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

cargo-clean — Remove generated artifacts

Description

       Remove artifacts from the target directory that Cargo has generated in the past.

       With no options, cargoclean will delete the entire target directory.

Environment

       See thereference <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for details on
       environment variables that Cargo reads.

Examples

        1. Remove the entire target directory:

               cargo clean

        2. Remove only the release artifacts:

               cargo clean --release

Exit Status

0: Cargo succeeded.

       •  101: Cargo failed to complete.

Name

       cargo-clean — Remove generated artifacts

Options

PackageSelection
       When no packages are selected, all packages and all dependencies in the workspace are cleaned.

       -pspec…, --packagespec…
           Clean only the specified packages. This flag may be specified multiple times. See cargo-pkgid(1) for
           the SPEC format.

   CleanOptions--dry-run
           Displays a summary of what would be deleted without deleting anything. Use with --verbose to display
           the actual files that would be deleted.

       --doc
           This option will cause cargoclean to remove only the doc directory in the target directory.

       --release
           Remove all artifacts in the release directory.

       --profilename
           Remove all artifacts in the directory with the given profile name.

       --target-dirdirectory
           Directory for all generated artifacts and intermediate files. May also be specified with the
           CARGO_TARGET_DIR environment variable, or the build.target-dirconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to target in the root of the
           workspace.

       --targettriple
           Clean for the given architecture. The default is the host architecture. The general format of the
           triple is <arch><sub>-<vendor>-<sys>-<abi>. Run rustc--printtarget-list for a list of supported
           targets. This flag may be specified multiple times.

           This may also be specified with the build.targetconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>.

           Note that specifying this flag makes Cargo run in a different mode where the target artifacts are
           placed in a separate directory. See the buildcache
           <https://doc.rust-lang.org/cargo/guide/build-cache.html> documentation for more details.

   DisplayOptions-v, --verbose
           Use verbose output. May be specified twice for “very verbose” output which includes extra output such
           as dependency warnings and build script output. May also be specified with the term.verboseconfigvalue <https://doc.rust-lang.org/cargo/reference/config.html>.

       -q, --quiet
           Do not print cargo log messages. May also be specified with the term.quietconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>.

       --colorwhen
           Control when colored output is used. Valid values:

           •  auto (default): Automatically detect if color support is available on the terminal.

           •  always: Always display colors.

           •  never: Never display colors.

           May also be specified with the term.colorconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>.

   ManifestOptions--manifest-pathpath
           Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current
           directory or any parent directory.

       --locked
           Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file
           was originally generated. Cargo will exit with an error when either of the following scenarios
           arises:

           •  The lock file is missing.

           •  Cargo attempted to change the lock file due to a different dependency resolution.

           It may be used in environments where deterministic builds are desired, such as in CI pipelines.

       --offline
           Prevents Cargo from accessing the network for any reason. Without this flag, Cargo will stop with an
           error if it needs to access the network and the network is not available. With this flag, Cargo will
           attempt to proceed without the network if possible.

           Beware that this may result in different dependency resolution than online mode. Cargo will restrict
           itself to crates that are downloaded locally, even if there might be a newer version as indicated in
           the local copy of the index. See the cargo-fetch(1) command to download dependencies before going
           offline.

           May also be specified with the net.offlineconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>.

       --frozen
           Equivalent to specifying both --locked and --offline.

   CommonOptions+toolchain
           If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be
           interpreted as a rustup toolchain name (such as +stable or +nightly). See the rustupdocumentation
           <https://rust-lang.github.io/rustup/overrides.html> for more information about how toolchain
           overrides work.

       --configKEY=VALUE or PATH
           Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or
           provided as a path to an extra configuration file. This flag may be specified multiple times. See the
           command-lineoverridessection
           <https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides> for more information.

       -CPATH
           Changes the current working directory before executing any specified operations. This affects things
           like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories
           searched for discovering .cargo/config.toml, for example. This option must appear before the command
           name, for example cargo-Cpath/to/my-projectbuild.

           This option is only available on the nightlychannel
           <https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> and requires the -Zunstable-options
           flag to enable (see #10098 <https://github.com/rust-lang/cargo/issues/10098>).

       -h, --help
           Prints help information.

       -Zflag
           Unstable (nightly-only) flags to Cargo. Run cargo-Zhelp for details.

See Also

cargo(1), cargo-build(1)

                                                                                                  CARGO-CLEAN(1)

Synopsis

cargoclean [options]

See Also