在终端中创作 Amplitude 项目
用于管理 Amplitude 项目的官方命令行工具。创建项目、制作资源、验证并构建,全部通过简单的命令完成,可手动运行,也可在脚本中调用。
$ curl -fsSL https://cli.amplitudeaudiosdk.com/install.sh | bash 处于早期开发阶段:命令和输出可能随版本变化。
# 创建项目并进入目录 $ am project init my_game $ cd my_game # 创建循环播放的脚步声 $ am asset sound create footstep \ --file audio/step.wav --bus sfx --gain 0.8 --loop # 检查所有资源,然后为运行时构建 $ am project validate $ am project build --output dist/
从空文件夹到运行时资源
Amplitude 由数据驱动:SDK 读取 JSON,CLI 为你编写、检查并打包这些 JSON。
开始一个项目
基于模板生成项目目录结构。除非另行指定,项目会注册到 CLI。
am project init my_game创建资源
声音、集合、效果、开关、事件、音频库、衰减、RTPC、管线和总线;省略某个值时会提示你输入。
am asset sound create explosion --file audio/explosion.wav --bus sfx发现错误
按 SDK 模式检查所有资源、总线文件和引擎配置(包括引用),迭代时也可以一次只检查一种类型。
am project validate --sounds-only交付给引擎
先验证,再把可供运行时使用的资源写入构建文件夹。可先清理该文件夹,也可在出现第一个错误时停止。
am project build --output dist/ --clean现在就能运行的命令
运行 am --help 查看完整列表,或在任意命令后添加 --help 查看详细说明
am project init [name] --template --no-register基于已注册的模板创建新项目。
am project register [path] 注册已有项目。
am project unregister <name> --delete-files取消注册项目,也可同时删除其文件。
am project list --favorite --no-favorite列出所有已注册的项目。
am project favorite <name> --set --unset将项目标记或取消标记为收藏。
am project info [name] 显示项目详情。未指定名称时使用当前目录。
am project validate --sounds-only --rtpc-only --buses-only …验证项目中的所有资源、总线文件和引擎配置,也可只验证某一类型。
am project build --output --clean --fail-fast为运行时构建项目资源。
--json--non-interactive-q, --quiet-v, --verbose手动使用很友好,脚本中行为可预测
省略某个值时,CLI 会提示你输入。传入 --non-interactive 后,它会直接报错而不是提示。
- 任何命令都可使用
--json输出机器可读结果 - 验证、资源、项目、SDK 和构建失败各有不同的错误码
- 引用检查严格:缺失的资源会报错,仍在使用的资源无法删除
- 支持 bash、zsh 和 fish 的 shell 补全
# 用你自己的工具解析结果 $ am project list --json $ am asset sound list --json $ am project validate --json # 永不等待提示 $ am --non-interactive asset event delete play_music --yes
起步阶段,公开成长
CLI 目前为 0.1 版本,变化较快。接下来计划推出终端界面,让你无需离开终端即可浏览和编辑项目。
项目管理
已提供- 项目生命周期:init、register、list、favorite、info
- 资源生命周期:create、list、update、delete,并检查引用
- 项目验证与构建
- 项目模板,包括自定义模板
- JSON 输出与非交互模式
终端界面
计划中基于相同命令、由键盘驱动的项目交互视图。此草图仅展示构想,之后会有变化。
获取 am 可执行文件
运行安装脚本、下载发行版,或从源码构建。
安装脚本
最快方式一条命令即可安装 CLI。你可以先在这里阅读脚本: install.sh · install.ps1
$ curl -fsSL https://cli.amplitudeaudiosdk.com/install.sh | bash PS> powershell -NoProfile -Command "iex (irm 'https://cli.amplitudeaudiosdk.com/install.ps1')" 预编译二进制文件
发行版发布在 GitHub,支持五个目标平台。
- Linux · x86_64, aarch64
- macOS · Intel, Apple Silicon
- Windows · x86_64
每个压缩包包含 am、shell 补全、README 和许可证,并附带 SHA-256 校验和,以及可用 gh attestation verify 验证的构建来源证明。
# 构建时需要 SDK git clone https://github.com/AmplitudeAudio/cli.git git clone https://github.com/AmplitudeAudio/sdk.git export AM_SDK_PATH="$(pwd)/sdk" cd cli && cargo build # 检查 CLI 能否找到 SDK $ am sdk check # Tab 补全 $ am completions zsh > ~/.zfunc/_am