TL;DR

既存の Git リポジトリをテンプレートにして、新しい Rust のプロジェクトを作るツール。

なぜ必要か

公式の README によると、cargo-generate は、既存の Git リポジトリをテンプレートとして使うことで、新しい Rust のプロジェクトをすぐに動かし始められるようにする開発者向けのツールである。よく使う構成をテンプレートのリポジトリにしておけば、プロジェクトを作るたびに同じ準備を繰り返さずに済む。

仕組み

cargo install cargo-generate --locked でインストールする。ビルド済みのバイナリを使うなら cargo binstall cargo-generate でもよい。

cargo generate にテンプレートのリポジトリを渡すと、そこから新しいプロジェクトを作る。GitHub のリポジトリは ユーザー名/リポジトリ名 の短い形で指定できる。GitLab は gl:、Bitbucket は bb:、SourceHut は sr: のプレフィックスを付ける。

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

テンプレートは GitHub で cargo-generate のトピックを検索すると見つかる。

例

Ratatui はテンプレートを用意している。

cargo generate ratatui/templates

関連

出典