#cargo #sample #repository #subcommand #set #quickly #up

app cargo-sample

A cargo subcommand to quickly set you up with a new rust project based on a crate example

5 unstable releases

0.3.0 Nov 21, 2024
0.2.0 Nov 18, 2024
0.1.2 Nov 17, 2024
0.1.1 Nov 17, 2024
0.1.0 Nov 17, 2024

#76 in Cargo plugins

Download history 260/week @ 2024-11-14 125/week @ 2024-11-21 5/week @ 2024-11-28

390 downloads per month

MIT license

235KB
155 lines

🍷 cargo-sample

A Cargo tool for bootstrapping new projects from repository examples. Always sample before you try.

instructional video

🧑‍🔧 Installation

cargo install cargo-sample

💡 Usage

Create a new project based on an example from any cargo package that has a repo with examples

e.g.

mkdir demo-folder && cd demo-folder
cargo sample axum

----- or ------------

cargo sample axum demo-folder

This will:

  1. Figure out the latest syable release of the crate
  2. Clone the repository to a temporary folder, checkout the proper branch
  3. Find the examples in the examples/ directory
  4. Prompt you to select an example
  5. Create a new project with the example's content on the demo folder

📈 TODO

  • search for examples everywhere in the repo
  • replace local dependencies in toml of examples for crates io dependencies
  • allow sampling on already existing dir, kind of importing an example to my local project

Dependencies

~15–29MB
~449K SLoC