MAN page from OpenSuSE cargo-1.36.0-lp151.5.4.1.i586.rpm

CARGO\-INIT

Section: \ \& (1)
Updated: 2019-01-23
Index

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 apath as an argument to create in the given directory.

If there are typically-named Rust source files already in the directory, thosewill be used. If not, then a sample src/main.rs file will be created, orsrc/lib.rs if --lib is passed.

If the directory is not already in a VCS repository, then a new repositoryis created (see --vcs below).

The "authors" field in the manifest is determined from the environment orconfiguration settings. A name is required and is determined from (first matchwins):

: *cargo-new.name Cargo config value

: *CARGO_NAME environment variable

: *GIT_AUTHOR_NAME environment variable

: *GIT_COMMITTER_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

: *GIT_AUTHOR_EMAIL environment variable

: *GIT_COMMITTER_EMAIL environment variable

: *user.email git configuration value

: *EMAIL environment variable

See https://doc.rust-lang.org/cargo/reference/config.html <L>the referencefor more information aboutconfiguration files.

See cargo-new(1) for a similar command which will create a new package ina 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 git or the configuration valuecargo-new.vcs, or none if already inside a VCS repository.

--registry REGISTRY

: This sets the publish field in Cargo.toml to the given registry namewhich will restrict publishing only to that registry.
Registry names are defined in https://doc.rust-lang.org/cargo/reference/config.html <L>Cargo config filesIf not specified, the default registry defined by the registry.defaultconfig key is used. If the default registry is not set and --registry is notused, the publish field will not be set which means that publishing will notbe restricted.

Display Options

-v, --verbose

: Use verbose output. May be specified twice for "very verbose" output whichincludes extra output such as dependency warnings and build script output.May also be specified with the term.verbosehttps://doc.rust-lang.org/cargo/reference/config.html <L>config value

-q, --quiet