cargo-sample
| Crates.io | cargo-sample |
| lib.rs | cargo-sample |
| version | 0.3.0 |
| source | src |
| created_at | 2024-11-17 10:20:54.719716 |
| updated_at | 2024-11-21 22:07:36.52471 |
| description | A cargo subcommand to quickly set you up with a new rust project based on a crate example |
| homepage | |
| repository | |
| max_upload_size | |
| id | 1451087 |
| size | 308,736 |
Luís Silva (LudeeD)
documentation
README
🍷 cargo-sample
A Cargo tool for bootstrapping new projects from repository examples. Always sample before you try.
🧑🔧 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:
- Figure out the latest syable release of the crate
- Clone the repository to a temporary folder, checkout the proper branch
- Find the examples in the
examples/directory - Prompt you to select an example
- 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