This command will create a new Cargo manifest in the current directory. Give a
path as an argument to create in the given directory.
If there are typically-named Rust source files already in the
directory, those will be used. If not, then a sample src/main.rs file
will be created, or src/lib.rs if --lib is passed.
If the directory is not already in a VCS repository, then a new
repository is created (see --vcs below).
The "authors" field in the manifest is determined from
the environment or configuration settings. A name is required and is
determined from (first match wins):
•cargo-new.name Cargo config value
•CARGO_NAME environment variable
•GIT_AUTHOR_NAME environment variable
•user.name git configuration value
•USER environment variable
•USERNAME environment variable
•NAME environment variable
The email address is optional and is determined from:
•cargo-new.email Cargo config value
•CARGO_EMAIL environment variable
•user.email git configuration value
•EMAIL environment variable
See the reference
https://doc.rust-lang.org/cargo/reference/config.html for more
information about configuration files.
See cargo-new(1) for a similar command which will create a
new package in a new directory.
Create a package with a binary target
(src/main.rs). This is the default behavior.
Create a package with a library target
Specify the Rust edition to use. Default is 2018.
Possible values: 2015, 2018, 2021
Set the package name. Defaults to the directory
Initialize a new VCS repository for the given version
control system (git, hg, pijul, or fossil) or do not initialize any version
control at all (none). If not specified, defaults to git or the
configuration value cargo-new.vcs, or none if already inside a
This sets the publish
field in Cargo.toml
to the given registry name which will restrict publishing only to that
Registry names are defined in Cargo config files
https://doc.rust-lang.org/cargo/reference/config.html. If not
specified, the default registry defined by the registry.default
config key is used. If the default registry is not set and --registry
is not used, the publish field will not be set which means that
publishing will not be restricted.
No output printed to stdout.
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.color config
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
). See the
for more information
about how toolchain overrides work.
Prints help information.
Unstable (nightly-only) flags to Cargo. Run cargo -Z
help for details.