@vgai/cli 0.5.5 → 0.5.6
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 +21 -13
- package/dist/index.js +2130 -1926
- package/package.json +8 -7
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ It talks to the editor dev server's HTTP/SSE control API via
|
|
|
13
13
|
npx @vgai/cli@latest create my-game
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
This creates a standalone
|
|
16
|
+
This creates a standalone project with normal versioned dependencies, installs it, opens its
|
|
17
17
|
visual editor, and prints the actual editor URL. Node.js 22 or newer is
|
|
18
18
|
required.
|
|
19
19
|
|
|
@@ -24,9 +24,8 @@ npm install --global @vgai/cli
|
|
|
24
24
|
vgai create my-game
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
links; `--registry` and `--link` override that choice explicitly.
|
|
27
|
+
Every CLI produces the same portable project shape. A checkout never changes
|
|
28
|
+
a project's dependency specs implicitly.
|
|
30
29
|
|
|
31
30
|
To remix a shipped reference project instead of starting blank:
|
|
32
31
|
|
|
@@ -41,7 +40,7 @@ the packaged reference or this repository.
|
|
|
41
40
|
|
|
42
41
|
```
|
|
43
42
|
vgai create <name> [location] [--template default|react] [--example <id>]
|
|
44
|
-
[--
|
|
43
|
+
[--no-edit] [--no-git]
|
|
45
44
|
vgai examples [--json] list reference projects available to --example
|
|
46
45
|
vgai edit [project-path] launch the editor for a project (default: cwd)
|
|
47
46
|
vgai worktrees [folder] list repository branches, worktrees, dirtiness, and sessions
|
|
@@ -78,9 +77,9 @@ vgai validate [folder] in-process: validate vgai.project.json, check ev
|
|
|
78
77
|
entry/scene/entryHtml/bundleUrl file exists, print the engine
|
|
79
78
|
pin (default: cwd) — no monorepo Vite/editor stack required
|
|
80
79
|
Exit codes: 0 valid, 1 invalid manifest or missing file, 2 usage
|
|
81
|
-
vgai
|
|
82
|
-
|
|
83
|
-
|
|
80
|
+
npm run vgai -- add deploy-vercel add project-owned Vercel scripts/config
|
|
81
|
+
npm run vgai -- add deploy-cloudflare add project-owned Wrangler scripts/config
|
|
82
|
+
npm run deploy run the selected provider's native CLI
|
|
84
83
|
|
|
85
84
|
--url <url> (or VGAI_EDITOR_URL) targets an exact editor URL
|
|
86
85
|
--port <n> / VGAI_EDITOR_PORT overrides the machine-local worktree allocation
|
|
@@ -137,15 +136,24 @@ another clone.
|
|
|
137
136
|
Contributors can build and link the current checkout:
|
|
138
137
|
|
|
139
138
|
```bash
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
139
|
+
# engine checkout
|
|
140
|
+
npm run dev:packages
|
|
141
|
+
|
|
142
|
+
# existing game project; package.json and package-lock.json stay versioned
|
|
143
|
+
VGAI_ENGINE_ROOT=/absolute/path/to/vgai-engine
|
|
144
|
+
npm link --no-save "$VGAI_ENGINE_ROOT/packages/engine" \
|
|
145
|
+
"$VGAI_ENGINE_ROOT/packages/vgai-cli" \
|
|
146
|
+
"$VGAI_ENGINE_ROOT/packages/editor" \
|
|
147
|
+
"$VGAI_ENGINE_ROOT/packages/vgai-live" \
|
|
148
|
+
"$VGAI_ENGINE_ROOT/packages/vgai-sdk" \
|
|
149
|
+
"$VGAI_ENGINE_ROOT/packages/editor-sdk" \
|
|
150
|
+
"$VGAI_ENGINE_ROOT/packages/p2p-colyseus"
|
|
143
151
|
```
|
|
144
152
|
|
|
145
153
|
The bundle inlines the shared private scaffolder, so the public CLI and the
|
|
146
154
|
editor's New Project route use the same `scaffoldProject` implementation.
|
|
147
|
-
|
|
148
|
-
|
|
155
|
+
`vgai status` identifies the package as linked and prints its source path.
|
|
156
|
+
`npm install` restores the registry graph.
|
|
149
157
|
|
|
150
158
|
Learn and manual: https://vgai-learn.pages.dev
|
|
151
159
|
|