# cargo-generate [](https://github.com/cargo-generate/cargo-generate/actions?query=workflow%3ABuild+branch%3Amain+) [](https://crates.io/crates/cargo-generate) [](https://deps.rs/repo/github/cargo-generate/cargo-generate) [](https://matrix.to/#/#cargo-generate:matrix.org)

cargo, make me a project

cargo-generate is a developer tool to help you get up and running quickly with a new Rust project by leveraging a pre-existing git repository as a template.

Here's an example of using cargo-generate with [this template]:

Documentation

See the cargo-generate guide for complete documentation.

Quickstart

Installation

sh cargo install cargo-generate

Usage

```sh

templates on github

cargo generate --git https://github.com/username-on-github/mytemplate.git

or just

cargo generate username-on-github/mytemplate

templates on other git platforms

cargo generate gl:username-on-gitlab/mytemplate cargo generate bb:username-on-bitbucket/mytemplate

this scheme is also available for github

cargo generate gh:username-on-github/mytemplate

for a complete list of arguments and options

cargo help generate ```

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or opensource.org/licenses/MIT)

at your option.

Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. If you want to contribute to cargo-generate, please read our [CONTRIBUTING notes].

cargo-generate would not be what it is today without the wonderful contributions from the community. Thank you!