cargo-init - Create a new Cargo package in an existing directory
cargo init [options] [path]
CARGO-INIT(1) General Commands Manual CARGO-INIT(1)
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).
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, 2021
--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 git or the
configuration value cargo-new.vcs, or none if already inside a VCS
repository.
--registry registry
This sets the publish field in Cargo.toml to the given registry
name which will restrict publishing only to that registry.
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.
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.verbose
config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
-q, --quiet
No output printed to stdout.
--color when
Control when colored output is used. Valid values:
o auto (default): Automatically detect if color support is
available on the terminal.
o always: Always display colors.
o never: Never display colors.
May also be specified with the term.color config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Common Options
+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 rustup documentation
<https://rust-lang.github.io/rustup/overrides.html> for more
information about how toolchain overrides work.
-h, --help
Prints help information.
-Z flag
Unstable (nightly-only) flags to Cargo. Run cargo -Z help for
details.
ENVIRONMENT
See the reference
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>
for details on environment variables that Cargo reads.
EXIT STATUS
o 0: Cargo succeeded.
o 101: Cargo failed to complete.
EXAMPLES
1. Create a binary Cargo package in the current directory:
cargo init
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+----------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+----------------------+
|Availability | developer/rust/cargo |
+---------------+----------------------+
|Stability | Volatile |
+---------------+----------------------+
SEE ALSO
cargo(1), cargo-new(1)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://static.rust-
lang.org/dist/rustc-1.53.0-src.tar.xz.
Further information about this software can be found on the open source
community website at http://www.rust-lang.org/.
CARGO-INIT(1)