@emberkit/cli 0.1.2-alpha.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +77 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# @emberkit/cli
|
|
2
|
+
|
|
3
|
+
The CLI tool for EmberKit — scaffold, develop, and build EmberKit projects.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @emberkit/cli
|
|
9
|
+
# or
|
|
10
|
+
pnpm add -g @emberkit/cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Commands
|
|
14
|
+
|
|
15
|
+
### `emberkit create <name>`
|
|
16
|
+
|
|
17
|
+
Create a new EmberKit project.
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
emberkit create my-app
|
|
21
|
+
cd my-app
|
|
22
|
+
emberkit dev
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Options:
|
|
26
|
+
- `--no-install` — Skip dependency installation
|
|
27
|
+
|
|
28
|
+
### `emberkit dev`
|
|
29
|
+
|
|
30
|
+
Start the development server with HMR.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
emberkit dev
|
|
34
|
+
# or with options
|
|
35
|
+
emberkit dev --port 3000 --host localhost
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### `emberkit build`
|
|
39
|
+
|
|
40
|
+
Build for production.
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
emberkit build
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### `emberkit preview`
|
|
47
|
+
|
|
48
|
+
Preview the production build locally.
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
emberkit preview
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Generated Project Structure
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
my-app/
|
|
58
|
+
├── emberkit.config.ts
|
|
59
|
+
├── vite.config.ts
|
|
60
|
+
├── tsconfig.json
|
|
61
|
+
├── index.html
|
|
62
|
+
└── src/
|
|
63
|
+
├── index.tsx
|
|
64
|
+
└── routes/
|
|
65
|
+
├── _layout.tsx
|
|
66
|
+
├── index.tsx
|
|
67
|
+
└── about.tsx
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Requirements
|
|
71
|
+
|
|
72
|
+
- Node.js >= 18
|
|
73
|
+
- pnpm (recommended), npm, or yarn
|
|
74
|
+
|
|
75
|
+
## License
|
|
76
|
+
|
|
77
|
+
Apache-2.0
|