NAME cargo-update – Update the package dependencies SYNOPSIS cargo update [OPTIONS] DESCRIPTION Update dependencies as recorded in the local lock file. This command requires that a Cargo.lock already exists as generated by cargo build or related commands. If SPEC is given, then a conservative update of the lockfile will be performed. This means that only…
NAME cargo-uninstall – Remove a Rust binary SYNOPSIS cargo uninstall [OPTIONS] <SPEC> cargo uninstall (-h | –help) DESCRIPTION The argument SPEC is a package id specification (see cargo help pkgid) to specify which crate should be uninstalled. By default all binaries are uninstalled for a crate but the –bin and –example flags can be used…
NAME cargo-test – Execute unit and integration tests of a package SYNOPSIS cargo test [OPTIONS] [–] [<ARGS>…] DESCRIPTION Execute all unit and integration tests of a local package. All of the trailing arguments are passed to the test binaries generated for filtering tests and generally providing options configuring how they run. For example, this will…
NAME cargo-search – Search packages in crates.io SYNOPSIS cargo search [OPTIONS] <QUERY>… DESCRIPTION Search packages in crates.io. OPTIONS -h, –help Print this message. –host HOST Host of a registry to search in. –limit LIMIT Limit the number of results (default: 10, max: 100). -v, –verbose Use verbose output. -q, –quiet No output printed to stdout….
NAME cargo-rustdoc – Build a package’s documentation, using specified custom flags. SYNOPSIS cargo rustdoc [OPTIONS] [–] [<OPTS>…] DESCRIPTION The specified target for the current package (or package specified by SPEC if provided) will be documented with the specified <OPTS>… being passed to the final rustdoc invocation. Dependencies will not be documented as part of this…
NAME cargo-rustc – Compile a package and all of its dependencies SYNOPSIS cargo rustc [OPTIONS] [–] [<OPTS>…] DESCRIPTION The specified target for the current package (or package specified by SPEC if provided) will be compiled along with all of its dependencies. The specified … will all be passed to the final compiler invocation, not any…
NAME cargo-run – Run the current project SYNOPSIS cargo run [OPTIONS] [–] [<ARGS>…] DESCRIPTION Run the main binary of the local package (src/main.rs). If neither –bin nor –example are given, then if the project only has one bin target it will be run. Otherwise –bin specifies the bin target to run, and –example specifies the…
NAME cargo-publish – Upload a package to the registry. SYNOPSIS cargo publish [OPTIONS] DESCRIPTION Upload a package to the registry. OPTIONS -h, –help Print this message. –host HOST Host to upload the package to. –token TOKEN Token to use when uploading. –no-verify Don’t verify package tarball before publish. –manifest-path PATH Path to the manifest of…
NAME cargo-pkgid – Print a fully qualified package specification SYNOPSIS cargo pkgid [OPTIONS] [<SPEC>] DESCRIPTION Given a <SPEC> argument, print out the fully qualified package id specifier. This command will generate an error if <SPEC> is ambiguous as to which package it refers to in the dependency graph. If no <SPEC> is given, then the…
NAME cargo-package – Create a distributable tarball SYNOPSIS cargo package [OPTIONS] DESCRIPTION Assemble the local package into a distributable tarball. OPTIONS -h, –help Print this message. -l, –list Print files included in a package without making one. –no-verify Don’t verify the contents by building them. –no-metadata Ignore warnings about a lack of human-usable metadata. –manifest-path…
NAME cargo-owner – Manage the owners of a crate of the registry SYNOPSIS cargo owner [OPTIONS] [<CRATE>] DESCRIPTION This command will modify the owners for a package on the specified registry (or default). Note that owners of a package can upload new versions, and yank old versions. Explicitly named owners can also modify the set…
NAME cargo-new – Create a new cargo package SYNOPSIS cargo new [OPTIONS] <PATH> DESCRIPTION Create a new cargo package at <PATH>. Use the –vcs option to control the version control system to use. OPTIONS -h, –help Print this message. –vcs VCS Initialize a new repository for the given version control system (git or hg) or…
NAME cargo-metadata – Machine-readable metadata about the current project SYNOPSIS cargo metadata [OPTIONS] DESCRIPTION Output the resolved dependencies of a project, the concrete used versions including overrides, in machine-readable format. OPTIONS -h, –help Print this message. –features FEATURES Space-separated list of features. –all-features Build all available features. –no-default-features Do not include the default feature. –no-deps…
NAME cargo-login – Save an API token from the registry locally SYNOPSIS cargo login [OPTIONS] [<TOKEN>] OPTIONS -h, –help Print this message. –host HOST Host to set the token for -v, –verbose Use verbose output. -q, –quiet No output printed to stdout. –color WHEN Coloring: auto, always, never. SEE ALSO cargo(1), cargo-publish(1) COPYRIGHT This work…
NAME cargo-install – Install a Rust binary SYNOPSIS cargo install [OPTIONS] <CRATE> cargo install [OPTIONS] –list DESCRIPTION Install a Rust binary This command manages Cargo’s local set of install binary crates. Only packages which have [[bin]] targets can be installed, and all binaries are installed into the installation root’s bin folder. The installation root is…
NAME cargo-init – Create a new cargo package in the current directory SYNOPSIS cargo init [OPTIONS] DESCRIPTION Create a new cargo package in the current directory. Use the –vcs option to control the version control system to use. OPTIONS -h, –help Print this message. –vcs VCS Initialize a new repository for the given version control…
NAME cargo-generate-lockfile – Generate the lockfile for a project SYNOPSIS cargo generate-lockfile [OPTIONS] OPTIONS -h, –help Print this message. –manifest-path PATH Path to the manifest to generate a lockfile for. -v, –verbose Use verbose output. -q, –quiet No output printed to stdout. –color WHEN Coloring: auto, always, never. SEE ALSO cargo(1) COPYRIGHT This work is…
NAME cargo-fetch – Fetch dependencies of a package from the network SYNOPSIS cargo fetch [OPTIONS] DESCRIPTION If a lockfile is available, this command will ensure that all of the git dependencies and/or registries dependencies are downloaded and locally available. The network is never touched after a `cargo fetch` unless the lockfile changes. If the lockfile…
NAME cargo-doc – Build a package’s documentation SYNOPSIS cargo doc [OPTIONS] DESCRIPTION Build a package’s documentation. By default the documentation for the local package and all dependencies is built. The output is all placed in ‘target/doc’ in rustdoc’s usual format. If the –package argument is given, then SPEC is a package id specification which indicates…
NAME cargo-clean – Remove generated artifacts SYNOPSIS cargo clean [OPTIONS] DESCRIPTION Remove artifacts that cargo has generated in the past. If the –package argument is given, then SPEC is a package id specification which indicates which package should be built. If it is not given, then the current package is built. For more information on…