cargo-generate
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:
Installation
cargo install cargo-generate
Usage
Standard usage is to pass a --git
flag to cargo generate
. This will prompt you to enter the name of your project.
cargo generate --git https://github.com/githubusername/mytemplate.git
You can also pass the name of your project to the tool using the --name
flag:
cargo generate --git https://github.com/githubusername/mytemplate.git --name myproject
Templates
Templates are git repositories whose files contain placeholders. The current supported placeholders are:
{{authors}}
: this will be filled in by a function borrowed from Cargo's source code, that determines your information from Cargo's configuration.{{project-name}}
: this is supplied by either passing the--name
flag to the command or working with the interactive CLI to supply a name.{{crate_name}}
: the snake_case_version ofproject-name
Here's an example. If you have a great template that you'd like to feature here, please file an issue!
License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
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.