cargo init
NAME
cargo-init - Create a new Cargo package in an existing directory
SYNOPSIS
cargo init [OPTIONS] [PATH]
DESCRIPTION
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.nameCargo config value -
CARGO_NAMEenvironment variable -
GIT_AUTHOR_NAMEenvironment variable -
GIT_COMMITTER_NAMEenvironment variable -
user.namegit configuration value -
USERenvironment variable -
USERNAMEenvironment variable -
NAMEenvironment variable
The email address is optional and is determined from:
-
cargo-new.emailCargo config value -
CARGO_EMAILenvironment variable -
GIT_AUTHOR_EMAILenvironment variable -
GIT_COMMITTER_EMAILenvironment variable -
user.emailgit configuration value -
EMAILenvironment variable
See the reference for more information about configuration files.
See cargo-new(1) for a similar command which will create a new package in a new directory.
OPTIONS
Init Options
- --bin
-
Create a package with a binary target (
src/main.rs). This is the default behavior. - --lib
-
Create a package with a library target (
src/lib.rs). - --edition EDITION
-
Specify the Rust edition to use. Default is 2018. Possible values: 2015, 2018
- --name NAME
-
Set the package name. Defaults to the directory name.
- --vcs VCS
-
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
gitor the configuration valuecargo-new.vcs, ornoneif already inside a VCS repository. - --registry REGISTRY
-
This sets the
publishfield inCargo.tomlto the given registry name which will restrict publishing only to that registry.Registry names are defined in Cargo config files. If not specified, the default registry defined by the
registry.defaultconfig key is used. If the default registry is not set and--registryis not used, thepublishfield will not be set which means that publishing will not be restricted.
Display Options
- -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.verboseconfig value. - -q
- --quiet
-
No output printed to stdout.
- --color WHEN
-
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.colorconfig value. -
Common Options
- -h
- --help
-
Prints help information.
- -Z FLAG…
-
Unstable (nightly-only) flags to Cargo. Run
cargo -Z helpfor details.
ENVIRONMENT
See the reference for details on environment variables that Cargo reads.
Exit Status
- 0
-
Cargo succeeded.
- 101
-
Cargo failed to complete.
EXAMPLES
-
Create a binary Cargo package in the current directory:
cargo init