1 | **💛 You can help the author become a full-time open-source maintainer by [sponsoring him on GitHub](https://github.com/sponsors/egoist).**
|
2 |
|
3 | ---
|
4 |
|
5 | # aho
|
6 |
|
7 | [![npm version](https://badgen.net/npm/v/aho)](https://npm.im/aho) [![npm downloads](https://badgen.net/npm/dm/aho)](https://npm/im/aho) [![install size](https://packagephobia.com/badge?p=aho)](https://packagephobia.com/result?p=aho)
|
8 |
|
9 | > ultra simple project scaffolding
|
10 |
|
11 | ## Usage
|
12 |
|
13 | ```bash
|
14 | # NPM
|
15 | npx aho user/repo [destination]
|
16 | # PNPM
|
17 | pnpm dlx aho user/repo [destination]
|
18 | ```
|
19 |
|
20 | ## Flags
|
21 |
|
22 | ### `aho <repo> [destination]`
|
23 |
|
24 | Generate a project from `<repo>` to `[destination]`, destination defaults to current directory.
|
25 |
|
26 | `<repo>` is in the format of `user/repo#branch_or_tag`, currently only GitHub repositories are supported. `#branch_or_tag` is optional.
|
27 |
|
28 | You can also download a sub folder from the repo: `user/repo/sub_folder#dev`.
|
29 |
|
30 | ### `--force`
|
31 |
|
32 | By default the command would abort if destination is not empty, use `--force` if you want to empty the dir before writing to it.
|
33 |
|
34 | ## Sponsors
|
35 |
|
36 | [![sponsors](https://sponsors-images.egoist.sh/sponsors.svg)](https://github.com/sponsors/egoist)
|
37 |
|
38 | ## License
|
39 |
|
40 | MIT © [EGOIST](https://github.com/sponsors/egoist)
|