|
1 | 1 | > vp new -h # show help |
| 2 | +Usage: vite new [OPTION]... [DIRECTORY] |
2 | 3 |
|
3 | | -vite new - Create a new Vite+ project |
4 | | - |
5 | | -Usage: |
6 | | - vite new [project-name] [project-type] [options] |
7 | | - vite new --app <path> Add an app to existing monorepo |
8 | | - vite new --lib <path> Add a library to existing monorepo |
9 | | - |
10 | | -Arguments: |
11 | | - project-name Name of the project to create |
12 | | - project-type Type of project: monorepo, mono, singlerepo, single |
| 4 | +Create a new Vite+ project in TypeScript. |
| 5 | +With no arguments, start the CLI in interactive mode. |
13 | 6 |
|
14 | 7 | Options: |
15 | | - --monorepo, -m Create a monorepo project |
16 | | - --singlerepo, -s Create a singlerepo project |
17 | | - --app <path> Add an app package to existing monorepo |
18 | | - --lib <path> Add a library package to existing monorepo |
19 | | - --help, -h Show this help message |
20 | | - |
21 | | -Examples: |
22 | | - vite new Interactive mode (prompts for all options) |
23 | | - vite new my-project Create project with prompts for type |
24 | | - vite new my-project monorepo Create monorepo without prompts |
25 | | - vite new my-project -s Create singlerepo using flag |
26 | | - vite new --app apps/my-app Add app to current monorepo |
27 | | - vite new --lib packages/utils Add library to current monorepo |
28 | | - |
29 | | -Notes: |
30 | | - - MonoRepo is the default when prompted (press Enter to select) |
31 | | - - Press Ctrl+C to exit during prompts |
32 | | - |
33 | | - |
34 | | -> vp new my-project monorepo # create monorepo |
35 | | - |
36 | | -Creating monorepo project: my-project... |
37 | | -✅ Successfully created monorepo project: my-project |
38 | | - |
39 | | -Next steps: |
40 | | - cd my-project |
41 | | - git init |
| 8 | + --monorepo create a monorepo project |
| 9 | + --app add an app to existing monorepo, e.g.: view new --app apps/website |
| 10 | + --lib add a library to existing monorepo, e.g.: view new --lib packages/utils |
| 11 | + -t, --template NAME use a specific template |
| 12 | + --pm NAME use a specific package manager, e.g.: view new --pm pnpm |
| 13 | + --git init git repository |
| 14 | + --overwrite overwrite existing files |
| 15 | + |
| 16 | +Available templates: |
| 17 | +vanilla-ts |
| 18 | +vue-ts |
| 19 | +react-ts |
| 20 | +preact-ts (WIP) |
| 21 | +lit-ts (WIP) |
| 22 | +svelte-ts (WIP) |
| 23 | +solid-ts (WIP) |
| 24 | +qwik-ts (WIP) |
| 25 | + |
| 26 | +> vp new --template vanilla-ts --monorepo --pm pnpm --git false --overwrite hello-vite-plus # create monorepo |
| 27 | +│ |
| 28 | +◇ Scaffolding project in hello-vite-plus/apps/website... |
| 29 | +│ |
| 30 | +└ Done. Now run: |
| 31 | + |
| 32 | + cd hello-vite-plus |
42 | 33 | vite run ready |
43 | 34 | vite run dev |
44 | 35 |
|
45 | | -To add new packages to your monorepo: |
| 36 | + To add new packages to your monorepo: |
| 37 | + |
46 | 38 | vite new --app apps/my-app |
47 | 39 | vite new --lib packages/my-lib |
48 | 40 |
|
49 | | -> cd my-project && vp new --app apps/my-app # add app |
50 | | -Creating new app at apps/my-app... |
51 | | -✅ Successfully created app at apps/my-app |
52 | 41 |
|
53 | | -Next steps: |
| 42 | +> cd hello-vite-plus && ls # check files |
| 43 | +README.md |
| 44 | +apps |
| 45 | +package.json |
| 46 | +pnpm-workspace.yaml |
| 47 | +tsconfig.json |
| 48 | +vite.config.ts |
| 49 | + |
| 50 | +> cd hello-vite-plus && vp new --app --template vanilla-ts apps/my-app # add app |
| 51 | +│ |
| 52 | +◇ Scaffolding project in apps/my-app... |
| 53 | +│ |
| 54 | +└ Done. Now run: |
| 55 | + |
54 | 56 | cd apps/my-app |
| 57 | + vite run ready |
55 | 58 | vite run dev |
56 | 59 |
|
57 | | -> cd my-project && ls apps |
| 60 | + |
| 61 | +> cd hello-vite-plus && ls apps |
58 | 62 | my-app |
59 | 63 | website |
60 | 64 |
|
61 | | -> cd my-project && vp new --lib packages/my-lib # add lib |
62 | | -Creating new library at packages/my-lib... |
63 | | -✅ Successfully created library at packages/my-lib |
| 65 | +> cd hello-vite-plus && vp new --lib packages/my-lib # add lib |
| 66 | +│ |
| 67 | +◇ Scaffolding project in packages/my-lib... |
| 68 | +│ |
| 69 | +└ Done. Now run: |
64 | 70 |
|
65 | | -Next steps: |
| 71 | + cd packages/my-lib |
66 | 72 | vite run ready |
| 73 | + vite run dev |
| 74 | + |
67 | 75 |
|
68 | | -> cd my-project && ls packages |
| 76 | +> cd hello-vite-plus && ls packages |
69 | 77 | my-lib |
70 | 78 |
|
71 | | -> cd my-project && vp new --lib tools/my-tool # add lib new not exists tools directory |
72 | | -Creating new library at tools/my-tool... |
73 | | -✅ Successfully created library at tools/my-tool |
| 79 | +> cd hello-vite-plus && vp new --lib tools/my-tool # add lib new not exists tools directory |
| 80 | +│ |
| 81 | +◇ Scaffolding project in tools/my-tool... |
| 82 | +│ |
| 83 | +└ Done. Now run: |
74 | 84 |
|
75 | | -Next steps: |
| 85 | + cd tools/my-tool |
76 | 86 | vite run ready |
| 87 | + vite run dev |
| 88 | + |
77 | 89 |
|
78 | | -> cd my-project && ls tools |
| 90 | +> cd hello-vite-plus && ls tools |
79 | 91 | my-tool |
0 commit comments