@aura3d/cli 1.4.1 → 1.4.3
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 +41 -38
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,33 +1,37 @@
|
|
|
1
1
|
# @aura3d/cli
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
Bring real 3D assets into a browser app without losing types, provenance, or
|
|
4
|
+
shipping confidence.
|
|
5
|
+
|
|
6
|
+
`@aura3d/cli` is the Aura3D command center for GLB/glTF projects. It finds
|
|
7
|
+
usable assets, copies local models into the right public path, records source
|
|
8
|
+
and license metadata, generates TypeScript references, validates game and
|
|
9
|
+
animation requirements, captures screenshots, and checks deploy output.
|
|
5
10
|
|
|
6
11
|
```bash
|
|
7
12
|
npx @aura3d/cli@latest doctor
|
|
8
13
|
```
|
|
9
14
|
|
|
10
|
-
##
|
|
15
|
+
## Why Developers Install It
|
|
16
|
+
|
|
17
|
+
- Real models, not placeholder primitives: add local GLB/glTF files or resolve
|
|
18
|
+
catalog candidates into a typed asset manifest.
|
|
19
|
+
- TypeScript references by default: routes import `assets.robot` instead of
|
|
20
|
+
hard-coded URLs that break later.
|
|
21
|
+
- Provenance travels with the app: source, license, quality, role, and hash
|
|
22
|
+
metadata stay in `aura.assets.json`.
|
|
23
|
+
- Game and animation checks are built in: inspect clips, humanoid structure,
|
|
24
|
+
fighting-character requirements, and release readiness from the same tool.
|
|
25
|
+
- Deployment is part of the workflow: validate assets, screenshots, and `dist`
|
|
26
|
+
output before you publish.
|
|
11
27
|
|
|
12
|
-
Add
|
|
28
|
+
## Add A Model
|
|
13
29
|
|
|
14
30
|
```bash
|
|
15
31
|
npx @aura3d/cli@latest assets add ./assets/robot.glb --name robot
|
|
16
32
|
npx @aura3d/cli@latest assets typegen
|
|
17
33
|
```
|
|
18
34
|
|
|
19
|
-
Search the Aura3D asset catalog:
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
npx @aura3d/cli@latest assets search "battle-worn knight helmet"
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
Resolve a verified catalog candidate into the local typed asset pipeline:
|
|
26
|
-
|
|
27
|
-
```bash
|
|
28
|
-
npx @aura3d/cli@latest assets resolve "battle-worn knight helmet" --name helmet
|
|
29
|
-
```
|
|
30
|
-
|
|
31
35
|
Then render the generated asset reference from a public Aura3D route:
|
|
32
36
|
|
|
33
37
|
```ts
|
|
@@ -35,13 +39,22 @@ import { createAuraApp, lights, model, scene } from "@aura3d/engine";
|
|
|
35
39
|
import { assets } from "./aura-assets";
|
|
36
40
|
|
|
37
41
|
createAuraApp("#app", {
|
|
38
|
-
scene: scene().add(model(assets.
|
|
42
|
+
scene: scene().add(model(assets.robot)).add(lights.studio())
|
|
39
43
|
});
|
|
40
44
|
```
|
|
41
45
|
|
|
42
|
-
##
|
|
46
|
+
## Find A Catalog Asset
|
|
43
47
|
|
|
44
|
-
|
|
48
|
+
```bash
|
|
49
|
+
npx @aura3d/cli@latest assets search "battle-worn knight helmet"
|
|
50
|
+
npx @aura3d/cli@latest assets resolve "battle-worn knight helmet" --name helmet
|
|
51
|
+
npx @aura3d/cli@latest assets typegen
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
`resolve` brings the chosen catalog result into the same typed local pipeline,
|
|
55
|
+
so the rest of the app still uses `model(assets.helmet)`.
|
|
56
|
+
|
|
57
|
+
## Command Shortlist
|
|
45
58
|
|
|
46
59
|
```bash
|
|
47
60
|
npx @aura3d/cli@latest assets add ./model.glb --name model
|
|
@@ -58,27 +71,17 @@ npx @aura3d/cli@latest init --agent all
|
|
|
58
71
|
|
|
59
72
|
## What It Writes
|
|
60
73
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
- `aura
|
|
64
|
-
|
|
65
|
-
- `src/aura-assets.ts` for generated TypeScript asset references;
|
|
66
|
-
- copied asset files under the configured public asset directory.
|
|
67
|
-
|
|
68
|
-
Public Aura3D examples should use generated `assets.name` references and
|
|
69
|
-
`model(assets.name)`. Avoid raw `.glb` or `.gltf` URLs, guessed model IDs,
|
|
70
|
-
direct loader code, and primitive-only primary subjects for named real objects.
|
|
71
|
-
|
|
72
|
-
## Package Roles
|
|
74
|
+
- `aura.assets.json`: asset manifest with source, license, quality, role,
|
|
75
|
+
provenance, and hash metadata.
|
|
76
|
+
- `src/aura-assets.ts`: generated TypeScript asset references for your routes.
|
|
77
|
+
- Public asset files under the configured app asset directory.
|
|
73
78
|
|
|
74
|
-
|
|
75
|
-
deploy checks.
|
|
76
|
-
- `create-aura3d`: Vite starter scaffolds.
|
|
77
|
-
- `@aura3d/engine`: public browser 3D runtime APIs such as `createAuraApp`.
|
|
79
|
+
## Best With
|
|
78
80
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
81
|
+
- `create-aura3d`: start a Vite browser 3D app with templates for product
|
|
82
|
+
viewers, cinematic scenes, animation workflows, and games.
|
|
83
|
+
- `@aura3d/engine`: render typed assets through the public `createAuraApp`
|
|
84
|
+
browser API.
|
|
82
85
|
|
|
83
86
|
## Links
|
|
84
87
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aura3d/cli",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.3",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"bin": {
|
|
6
6
|
"aura3d": "dist/cli.js",
|
|
@@ -24,9 +24,9 @@
|
|
|
24
24
|
"types": "./dist/index.d.ts",
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"typescript": "^5.8.3",
|
|
27
|
-
"@aura3d/asset-index": "1.4.
|
|
27
|
+
"@aura3d/asset-index": "1.4.3"
|
|
28
28
|
},
|
|
29
|
-
"description": "
|
|
29
|
+
"description": "Bring real GLB/glTF assets into Aura3D browser apps with typed references, provenance, catalog search, validation, screenshots, and deploy checks.",
|
|
30
30
|
"keywords": [
|
|
31
31
|
"aura3d",
|
|
32
32
|
"3d",
|