@ glassly/miniapp-cli (英语)
为 Glassly 微型应用程序构建工具: dev 服务器、 包机、 显示器
审定,以及 miniapp.json (原始内容存档于2013-10-10). JSON Schema. 与
@glassly/miniapp。 。 。 .
此套件没有自己的二进制. 这个 glassly 命令从
@glassly/cli 在此将每个函数包成
子命令,这是本文所描述的 :
glassly <command>
项目还直接导入: build.ts 用途
@glassly/miniapp-cli/build-helpers,以及 miniapp.json 点数 $schema 时间
node_modules/@glassly/miniapp-cli/schema/miniapp.schema.json这就是为什么它
将 dev 依赖保留在旁边 @glassly/cli。 。 。 .
浏览图标
| 命令 | 它会做什么 |
|---|---|
dev | 以热重装启动 dev 服务器, 打印一个 QR 以装入到电话中 |
sim | 在桌面模拟器中运行小应用程序; 子命令驱动它 |
release | 在局域网的电话上安装释放的QR |
pack | 验证清单和拉链 dist/ 输入 <pkg>-<version>.zip |
manifest | 用于编辑的交互式顶级向导 miniapp.json |
permission list | add | remove | 对象动词列表编辑权限 |
hardware list | add | remove | 用于硬件需求的对象动词表编辑 |
schema print | 打印峡谷 miniapp.json JSON Schema 调试 |
运行 glassly --help 以打印同一列表.
dev
glassly dev
glassly dev --qr lg # QR size: sm | md | lg (default md); -q also works
glassly dev --qr-output ./qr.png # also write the QR as a PNG, kept after exit
glassly dev --no-iroh # LAN-only QR
它会做什么:
- 读取+验证
miniapp.json(硬故障在不良权限 / 硬件类型,所以不需要在电话中调试). - 运行项目
build.ts这样dist/background/index.js财务报告和审定财务报表dist/ui/*是当前. - 选择第一个自由相邻的端口对开始于
port:一个用于静态文件,另一个用于dev侧车. - 启动服务于
miniapp.json, (中文(简体) ),icon.png,以及工程文件. - 开始 a dev 侧车 打开
port + 1,一个WebSocket 连接的手机,用于实时重装+控制台-日志转发回您的终端. 这里的失败是非致命的;小程序仍然运行而不进行活重装. - 捆绑 an iro 端点( 每个包的密钥保存在
~/.glassly/dev-tunnel/转发到两个服务器的电话流 跳过--no-iroh或在何处@number0/iroh没有约束(Intel Macs). - 检测局域网IP,构建一个
miniapp://dev?url=…&name=…&package=…&dev=<sidecarPort>&iroh=<ticket>&token=…URL,并打印一个终端QR+原始URL. 旧的 Glassly App 构建忽略iroh编号 :token和使用情况url。 。 。 . - 观察LAN-IP的更改(Wi-Fi switch)每2回并再版QR.
默认 port 实值 3000; 以一个 "port": <n> 输入 miniapp.json如果港口或者它的侧车邻居很忙, dev 向上扫描直到找到自由相邻的对.
在电话里,打开玻璃App 设置 ~ miniapp 开发者设置 ~ 扫描 miniapp QR 代码。设置行只显示调试模式。 有了iroh票,电话就可以在任何网络上;更古老的Glassly App建筑需要同样的Wi-Fi.
两者 dev 财务报告和审定财务报表 release 使用相同的QR旗. --qr 编号 : -q 终端 QR 大小(small|medium|large,或 sm|md|lg; 默认 medium) (中文(简体) ). --qr-output <path> 也写了PNG. 没有它, CLI 仍然将 PNG 写入临时路径, 并在退出时删除; pass --qr-output 当您想要保存文件时.
dev 是现场和临时的。 保持CLI和计算机的运行,因为
Glassly App从局域网服务器装入运行时间捆绑. Dev 微型应用程序已按键
通过它们显示的包名,可以同时扫描和测试几个;
重新扫描同一软件包只更新该条目 。 Glassly App 缓存每个
条目的名称和图标。 使用 bun run release 当您需要安装的微型应用程序时
没有电脑就能工作.
Ctrl+C 停止服务器,侧车,IP监视器.
sim
glassly sim # build, run, open the simulator window
glassly sim --no-open # same, without a browser
glassly sim --detach # start in the background, return once it answers
运行一个没有手机和眼镜的小型程序:
- 验证
miniapp.json并运行项目build.ts。 。 。 . - 评价
dist/background/index.js在一个提供__dispatch连接SDK的DispatchTransport期待着 节点和节点 手机的JS环境缺乏(process, (中文(简体) ),Buffer, (中文(简体) ),require, (中文(简体) ),performance隐藏在捆绑. - 回答捆绑请求
SimHost(单位:千美元)src/sim/host.ts页:1 镜像 Glassly App 的运行时间 它覆盖和回复的电话NOT_IMPLEMENTED剩下的钱 镜头通过SDK自己的processScene编号 :diffScene(单位:千美元)@glassly/miniapp/display),代码应用程序 运行,与应用程序的模拟眼镜剖面相悖. - 为模拟窗口服务, 小应用程序的用户界面页面
/ui/(与window.Glassly全球和window.glassly嘘从@glassly/miniapp/host和JSON控制 API 下级/api/,所有打开127.0.0.1(默认端口)4500) (中文(简体) ). - 观看项目:更改
src/ui/重新装入页面, 其他任何东西 也重新启动背景 .
每个 glassly sim <subcommand> (单位:千美元)screen, (中文(简体) ), screenshot, (中文(简体) ), tap, (中文(简体) ), say, (中文(简体) ), logs, (中文(简体) ),
ui request, )是运行于模拟器上的控制 API 的呼叫
当前工程,通过OS临时目录中的记录找到.
screenshot 从屏幕上提取显示 MirrorCanvasRenderer 打开
@napi-rs/canvas,窗口使用的同一渲染器.
模拟器需要一个 @glassly/miniapp 出口额 @glassly/miniapp/host· ;
在老的SDK上面 上面写着这样,然后离开.
它包括哪些内容,不包括哪些内容,在公众文件中列出: https://docs.glasslyos.com/app-devs/getting-started/simulator 互联网档案馆的存檔,存档日期2013-12-21。 。 。 .
release
glassly release
glassly release --no-cache # force rebuild even if cache is fresh
glassly release --qr lg # QR size: sm | md | lg (default md); -q also works
glassly release --qr-output ./qr.png
全能一动词:构建出一个发布,打包,并在QR后服务,这样就可以安装在您喜欢的手机上.
流量 :
- 验证
miniapp.json。 。 。 . - 构建缓存 . 寻找
build/<packageName>-<version>.zip。如果它存在,并且每个项目源文件(不包括node_modules, (中文(简体) ),dist, (中文(简体) ),build, (中文(简体) ),.git)比拉链长,再用. 否则重建. - 盖起. 检测您的软件包管理器( E)
bun.lock→bun, (中文(简体) ),pnpm-lock.yaml→pnpm, (中文(简体) ),yarn.lock→yarn,则npm运行<pm> run build。您的package.json必须定义一个build产生脚本dist/。 。 。 . - 包装. 所谓的逻辑与
glassly pack: 验证清单,复制件miniapp.json+ 键icon.png输入dist/,拉链到build/<packageName>-<version>.zip。打印大小+持续时间. - 服务. 选取6789至6798之间的自由港. 在 HTTP 上托管捆绑、 显示和图标
0.0.0.0数字 :GET /miniapp.jsonGET /icon.pngGET /bundle.zipGET /__host_release/health
- 打印 a
miniapp://release?url=<lan-base>&package=…&version=…&name=…URL + QR. (中文(简体) ). - 保持高度,使多个设备可以安装. 每个
/bundle.zip获取日志✓ Install #N: <name>@<version> → <remote>。 。 。 .
Ctrl+C 停止服务器.
在电话上,Glassly App的QR扫描仪的分机 miniapp://release 并使用 Dev 作曲器下载 + 安装捆绑. 迷你应用土地 lmas/<package>/<version>/ 并表现得像任何安装的本地微型app:它运行于下线,在重启时坚持,安装后不需要笔记本电脑.
为什么"释放"而不"安装":
install与软件包管理器相撞( e)bun run install页:1 在你制作的艺术品之后命名动作 避免了碰撞 并符合Android的installRelease精神模特儿.
pack
glassly pack
glassly pack --no-build # zip dist/ as-is, skip the build
生产可分配的ZIP. 你只要这些文物就用这个; release 电话 pack 内部.
步骤 :
- 运行
<pm> run build与NODE_ENV=production(与release),所以拉链总是包含一个生产捆绑, 从来没有一个被留下的 stale dev 建筑dev。通过--no-build跳过这个并拉链 任何已经包含dist/。 。 。 . - 验证
dist/已存在. - 验证
miniapp.json。 。 。 . - 副本
miniapp.json财务报告和审定财务报表icon.png输入dist/。 。 。 . - 运行系统
zip -r要生成的命令build/<packageName>-<version>.zip并打印绝对路径.
build/ 正在自爆: CLI 写着 .gitignore 包含 * 在创建时,在任何回放中, 包装的拉链都不受版本控制, 不触及项目本身 .gitignore。 。 。 .
产生的ZIP是您上传到小苹果店的文物.
要求
zip二进制打开PATH(在macOS和大多数Linux distros上安装). 在窗口上安装zip通过WSL或使用类似Unix的外壳.
manifest
glassly manifest
交互式顶级向导 miniapp.json (简体中文). 循环 :
- 编辑权限: 添加, 删除
- 编辑硬件要求: 添加, 删除
- 显示当前列表: 漂亮地打印 JSON
- 已执行: 退出
每一次确证的变化后 都会坚持下去 所以 Ctrl+C 永不丢失已保存的编辑.
向导分享其变异后端( Q)manifest-mutate.ts)以下为对象-动词命令;行为和验证完全相同.
permission
glassly permission list
glassly permission add [TYPE]
glassly permission remove [TYPE]
add 编号 : remove 调用时为交互 TYPE ( Clack 选择的提示) 和 当 TYPE 提供.
允许 TYPE 值 : MICROPHONE, (中文(简体) ), CAMERA, (中文(简体) ), CALENDAR, (中文(简体) ), LOCATION, (中文(简体) ), BACKGROUND_LOCATION, (中文(简体) ), READ_NOTIFICATIONS, (中文(简体) ), POST_NOTIFICATIONS, (中文(简体) ), API_KEYS, (中文(简体) ), MEMORY, (中文(简体) ), AI, (中文(简体) ), SPEAKERS, (中文(简体) ), DISPLAY_MIRROR, (中文(简体) ), MANAGE_MINIAPPS, (中文(简体) ), PLATFORM_SETTINGS。 。 。 .
添加许可交互提示可选择的人可读描述(当用户被要求许可时在OS提示中shown). Glassly App在微型app发射时要求每次宣布的许可:首先需要许可(降级使其关闭),然后是可选许可("required": false在一个可跳跃的警报.
hardware
glassly hardware list
glassly hardware add [TYPE] [LEVEL]
glassly hardware remove [TYPE]
允许 TYPE 值 : CAMERA, (中文(简体) ), DISPLAY, (中文(简体) ), MICROPHONE, (中文(简体) ), SPEAKER, (中文(简体) ), IMU, (中文(简体) ), BUTTON, (中文(简体) ), LIGHT, (中文(简体) ), WIFI。 。 。 .
允许 LEVEL 值 : REQUIRED, (中文(简体) ), OPTIONAL。 。 。 .
REQUIRED:没有这种硬件的眼镜不能运行应用程序(隐藏在商店/发射装置上不兼容).OPTIONAL:没有这种硬件的眼镜仍然运行应用程序,处于退化状态.
调用时添加为交互式 TYPE 编号 : LEVEL. 非互动形式要求两者兼有.
这个
EXIST硬件类型在运行时由电话注入(每个小程序都隐含地要求有眼镜). 它故意不在被允许类型列表中,所以不要声明.
schema
glassly schema print
打印峡谷 miniapp.json JSON 斯克马给Studout。 用于管道输入 IDE 配置或 CI 中的验证 .
计数由验证器使用的相同常数产生(ALLOWED_PERMISSIONS, (中文(简体) ), ALLOWED_HARDWARE_TYPES, (中文(简体) ), ALLOWED_HARDWARE_LEVELS),因此它永远不能从验证行为中漂移.
已公布的 schema 文件船在 node_modules/@glassly/miniapp-cli/schema/miniapp.schema.json 用于编辑 $schema 从 miniapp.json. 脚手架(@glassly/create-miniapp) 注射这个 $schema 自动行入新项目.
glassly schema regenerate也存在, 但是是软件包- 内部的: 它从内源允许值列表中重写已公布的 schema 文件( )bun run build这里也一样)。 作者不须.
miniapp.json 形状
{
"$schema": "./node_modules/@glassly/miniapp-cli/schema/miniapp.schema.json",
"packageName": "com.glassly.example",
"version": "1.0.0",
"name": "Glassly Example",
"description": "…",
"icon": "icon.png",
"port": 3000,
"type": "standard",
"sdkVersion": "0.3.0",
"minHostVersion": "0.3.0",
"entry": {
"background": "background/index.js",
"ui": "ui/index.html"
},
"permissions": [{"type": "MICROPHONE", "description": "Listen for what to caption."}],
"hardwareRequirements": [
{"type": "DISPLAY", "level": "REQUIRED"},
{"type": "MICROPHONE", "level": "REQUIRED"}
],
"actions": [
{
"id": "start_caption",
"description": "Start live captions on the glasses. Use when the user asks to caption a conversation.",
"visibility": "public",
"parameters": {"type": "object", "properties": {"language": {"type": "string"}}}
}
]
}
要求 : packageName, (中文(简体) ), version, (中文(简体) ), name, (中文(简体) ), hardwareRequirements其它一切都是可选的.
| 外地 | 它会做什么 |
|---|---|
entry | 双层捆绑出入口. background (如果需要的话)是总运行的JScontext条目,例如. background/index.js· ; ui 是点播的WebView条目 HTML。 纯背景小应用程序省略 ui。 。 。 . |
type | "standard" (默认,载运UI Webview), "background" (只有JSContext),或 "dashboard" (可以持有"仪表盘"角色:一次一个"仪表盘"运行并获得显示上覆槽;自己不授予权限. |
alwaysOn | 布尔, 默认值 false。从主机启动时开始,当其交换机卡被解除时,则保持背景运行。 穿戴者可以超越这个默认并明确停止微型app. |
sdkVersion | 国王 @glassly/miniapp SDK这个捆绑的目标. |
minHostVersion | 可运行此捆绑的Lowest Glassly App版本;该应用报告其发布家族版本(今天为0.3.0). Glassly Miniapp商店不会安装或更新其发行版本 minHostVersion 在运行的Glassly App之上, 并在它的卡和页面上这样说. |
actions | 其他微型应用程序可通过下列途径发现和引用的行动: session.actions,将 1:1 映射到 MCP 工具上。 每个需要 id (低调, ^[a-z][a-z0-9_]*$,""("64 Chars")和"AI-facing"(A description· ; visibility 实值 "public" (违约)或 "system" (系统微型应用程序,例如仅AI助理),以及 parameters 用于输入的 JSON Schema . |
sdkVersion财务报告和审定财务报表minHostVersion将对照计划进行验证。 只有 存储执行minHostVersion;运行时间在发射时也不检查 (主办方:checkManifestVersions闸门存在,从未被调用).
packageName 必须是倒数DNS(^[a-zA-Z][a-zA-Z0-9_]*(\.[a-zA-Z][a-zA-Z0-9_]*)+$) (中文(简体) ).
port 默认为 3000 页:1 dev 并被忽略 被忽略 release (它选择自己的自由港). 对于 dev,这是起始端口;如果端口或其侧车邻居忙于工作,则CLI向上扫描,直到找到一对相邻的免费对接.
允许值列表从工程安装中读取 @glassly/miniapp (单位:千美元)@glassly/miniapp/manifest),是同级依赖,因此验证者,计划,和宿主通过构建同意. SDK在导出之前的一个项目会收到明确的升级消息.
文件地图
- 命令执行(从
src/api.ts,电线到子命令@glassly/cli:src/{dev,release,pack,permission,hardware,schema,manifest-wizard}.ts - 表面验证 :
src/manifest.ts; 允许从 SDK 中加载的值 :src/manifest-vocabulary.ts - 明显的变异后端( 由向导 + 对象- 动词命令共享) :
src/manifest-mutate.ts - 读出/写出帮助者:
src/manifest-format.ts - 权限/ 硬件人类可读提示 :
src/permission-hints.ts - Dev 侧车 WebSocket 服务器 :
src/dev-server.ts - 模拟器 :
src/sim/(单位:千美元)sim.ts命令,host.ts协议,server.ts窗口 + 控制 API,background.ts工人们,screenshot.ts, (中文(简体) ),client/窗口页面) - QR 渲染 :
src/qr.ts - 生成了JSON斯克马:
schema/miniapp.schema.json(通过schema regenerate(中文(简体) )