You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> The official template to create a new Eruption project.
3
+
> The official template to create a Eruption project.
4
4
5
5
## Usage
6
6
7
-
To initialize a new project, run the following command:
7
+
To initialize a new project, run the following command (with you prefered package manager)):
8
8
9
9
```bash
10
10
npm init eruption@latest
11
11
```
12
12
13
+
```bash
14
+
yarn create eruption@latest
15
+
```
16
+
17
+
```bash
18
+
pnpm create eruption@latest
19
+
```
20
+
13
21
### Contributing to this CLI
14
22
23
+
The CLI uses [Clack](https://github.com/natemoo-re/clack) to generate the prompt. The main file is located in `lib/eruption-cli.mjs`. To run the CLI locally, run the following command on the root of the repository:
24
+
25
+
```bash
26
+
pnpm run dev
27
+
```
28
+
29
+
This command will run the CLI in watch mode, so you can make changes and see them reflected in the CLI.
30
+
15
31
### What is in this repository?
16
32
17
33
-[PNPM](https://pnpm.io/workspaces) as workspace manager and package manager.
@@ -20,13 +36,12 @@ npm init eruption@latest
20
36
-[Size Limit](https://github.com/ai/size-limit) as a size limit plugin.
21
37
-[Prettier](https://prettier.io/) as a code formatter.
22
38
-[ESLint](https://eslint.org/) as a code linter.
23
-
-[Turbo](https://turbo.build) as cacheable build tool.
24
39
25
40
### Folder structure
26
41
27
-
- docs - An empty folder to store documentation.
28
-
- lib - The CLI source.
42
+
-[docs](./docs/) - An empty folder to store documentation.
Copy file name to clipboardExpand all lines: lib/README.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,20 @@
4
4
5
5
## Usage
6
6
7
-
To initialize a new project, run the following command:
7
+
To initialize a new project, run the following command (with you prefered package manager)):
8
8
9
9
```bash
10
10
npm init eruption@latest
11
11
```
12
12
13
-
Or, if you prefer to use `yarn`:
14
-
15
13
```bash
16
14
yarn create eruption@latest
17
15
```
18
16
17
+
```bash
18
+
pnpm create eruption@latest
19
+
```
20
+
19
21
The CLI will ask you a few questions (_in interactive_ mode) and then create a new project for you, but you can also pass a few flags to skip the interactive mode.
0 commit comments