@aura3d/cli

中文文档
4.7.0发布于 2026/10/31MITTypeScriptES Module

将真正的GLB/glTF资产带入Aura3D浏览器应用程序,包括类型化引用、出处、目录搜索、验证、截图和部署检查。

中文使用文档
文档目录8 节
  1. 开发者为什么要安装它
  2. 添加模型
  3. 查找目录资产
  4. 导入网格候选对象
  5. 命令名单
  6. 它写了什么
  7. 最好与
  8. 链接

@aura3d / cli

将真正的3D资产带入浏览器应用程序,而不会丢失类型,来源或 航运的信心。每个模型都被输入、散列和授权:CLI记录 它的来源,许可证,作者和sha256 aura.assets.json,生成一个类型 assets.<name> 键, check-deploy 根据该结果检查构建输出 清单,所以是丢失的散列资产或者是丢失的文件 dist 在你面前失败 船。添加 --release 许可证和质量闸门,或 --browser 加载每一个 在headless Chromium中路由并在HTTP错误,请求失败,未捕获时失败 错误和控制台错误(它需要) playwright 在您的项目中)。

@aura3d/cli 是GLB/glTF项目的Aura3D指挥中心。它发现 可用的资产,复制本地模型到正确的公共路径,记录源 和许可元数据,生成TypeScript引用,验证游戏和 动画需求,捕获屏幕截图,并检查部署输出。

npx @aura3d/cli@latest doctor

开发者为什么要安装它

  • 真实模型,而不是占位符原语:添加本地GLB/glTF文件或解析 将候选对象编目到类型化的资产清单中。
  • TypeScript的默认引用:routes import assets.robot 而不是 稍后会中断的硬编码url。
  • 来源与应用程序一起传播:来源,许可,质量,角色和哈希 元数据保留 aura.assets.json.
  • 游戏和动画检查内置:检查剪辑,人形结构, 战斗角色要求,特定类别的游戏几何,以及来自同一工具的发布准备。
  • 经过认证的游戏资产无法关闭:赛车赛道和平台世界需要当前的哈希绑定几何探测,而路线证据将选择的配对绑定到保留的屏幕截图和验证报告。
  • 部署是工作流程的一部分:验证资产、屏幕截图和 dist 发布前的输出。

添加模型

npx @aura3d/cli@latest assets add ./assets/robot.glb --name robot
npx @aura3d/cli@latest assets typegen

然后从公共Aura3D路由渲染生成的资源引用:

import { createAuraApp, lights, model, scene } from "@aura3d/engine";
import { assets } from "./aura-assets";

createAuraApp("#app", {
  scene: scene().add(model(assets.robot)).add(lights.studio())
});

查找目录资产

npx @aura3d/cli@latest assets search "battle-worn knight helmet"
npx @aura3d/cli@latest assets resolve "battle-worn knight helmet" --name helmet
npx @aura3d/cli@latest assets typegen

resolve 将所选目录结果放入相同类型的本地管道中, 所以应用程序的其余部分仍然使用 model(assets.helmet).

导入网格候选对象

能力标签: CLI资产管道

网格生成通过固定的官方网格CLI运行。在本地下载完成的运行后,通过Aura3D接收选定的GLB:

npx @aura3d/cli@latest assets import-meshy artifacts/meshy/arena-relic/ \
  --name arenaRelic \
  --quality candidate \
  --role prop \
  --profile prop \
  --rights-evidence artifacts/meshy/arena-relic/rights.json

导入重用普通的Aura3D添加、检查、散列、清单和类型生成路径,并打印生成的内容 assets.arenaRelic 键加上接下来的验证步骤。它记录提供的权利证据并生成打字 model(assets.arenaRelic) 键 @aura3d/engine.

看到 网格命令行指南.

命令名单

npx @aura3d/cli@latest assets add ./model.glb --name model
npx @aura3d/cli@latest assets search "studio robot" --json
npx @aura3d/cli@latest assets resolve "studio robot" --name robot
npx @aura3d/cli@latest assets import-meshy artifacts/meshy/arena-relic/ --name arenaRelic --quality candidate --role prop --profile prop --rights-evidence artifacts/meshy/arena-relic/rights.json
npx @aura3d/cli@latest assets inspect ./model.glb --animation --humanoid
npx @aura3d/cli@latest assets validate --source --release
npx @aura3d/cli@latest assets validate-game --profile fighting-character --asset fighter
npx @aura3d/cli@latest assets validate-animation --clips idle,walk,run
npx @aura3d/cli@latest assets certify-game-geometry --asset track --category racing
npx @aura3d/cli@latest assets bind-game-route-evidence --route my-race --category racing --assets car,track --screenshot tests/reports/route.png --geometry-report tests/reports/topology.json --composition-report tests/reports/composition.json --visual-review docs/visual-review.json
npx @aura3d/cli@latest assets assemble-character --name hero --body heroBody --part hair=heroHair
npx @aura3d/cli@latest migrate three ./src
npx @aura3d/cli@latest check-deploy --dist dist
npx @aura3d/cli@latest check-deploy --dist dist --browser --route / --route /play/
npx @aura3d/cli@latest init --agent all

它写了什么

  • aura.assets.json:包含源、许可证、质量、角色、来源、哈希元数据、保留探针和可选哈希绑定的资产清单 gameGeometry 认证/证据。
  • src/aura-assets.ts:为你的路由生成TypeScript资源引用。
  • 配置的app资产目录下的公共资产文件。

最好与

  • create-aura3d:启动一个带有产品模板的Vite浏览器3D应用 观众,电影场景,动画工作流程和游戏。
  • @aura3d/engine:通过public渲染类型化资产 createAuraApp 浏览器API。

版本与发布记录

@aura3d/cli 共发布 52 个版本,首次发布于 2026/06/06;过去 12 个月发布了 52 个版本。

版本发布日期距今
4.7.0latest2026/10/312 天前
4.6.22026/10/304 天前
4.6.12026/10/304 天前
4.6.02026/10/304 天前
4.5.02026/10/295 天前
4.3.72026/10/286 天前

关于 @aura3d/cli 的常见问题

@aura3d/cli 是什么?

将真正的GLB/glTF资产带入Aura3D浏览器应用程序,包括类型化引用、出处、目录搜索、验证、截图和部署检查。

如何安装 @aura3d/cli?

在项目目录运行 npm install @aura3d/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cli、aura、aura3d,可以用 npx cli 直接运行。

@aura3d/cli 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@aura3d/cli 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@aura3d/cli 可以商用吗?

@aura3d/cli 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@aura3d/cli 还在维护吗?

最新版本 4.7.0 发布于 2026/10/31(2 天前);至今共发布 52 个版本,其中过去 12 个月发布了 52 个;首次发布于 2026/06/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。