Glassly Miniapp SDK betaThe SDK is in beta, so its APIs may change before general availability.Developing on Mentra Live? We recommend using the Glassly Bluetooth SDK.The developer tools are available in the Glassly App under Settings → Miniapp Developer Settings.Share feedback with an in-app bug report, on Discord, or by email at [email protected].
@glassly/cli provides the glassly command. Install it globally:
Every scaffolded project also has its own copy as a dev dependency. Inside a project, the global glassly runs that copy, so each project uses the tooling version its package.json pins. glassly update is the exception: it always runs the global copy, so an old project copy can still be updated.
The CLI is Bun-only: it ships as TypeScript and runs under Bun. Use bun (or bunx), not npx/Node.
Every project command takes --cwd <path> to run against a directory other than the current one.

update

Rewrites the @glassly/miniapp, @glassly/cli, and @glassly/miniapp-cli pins in package.json to the newest release on a channel (latest, beta, or dev), sets sdkVersion in miniapp.json to match, and runs bun install. It leaves minHostVersion alone, because raising it hides the miniapp from older Glassly App versions. The default channel is the one the project’s installed SDK comes from. It then upgrades the global glassly with the package manager that installed it (bun add -g or npm install -g). Once a day the CLI checks npm for newer versions of the global CLI and the project’s packages. When something is behind, it prints a one-line notice before the command runs. Set GLASSLY_NO_UPDATE_CHECK=1 to turn the check off. It is already off when CI is set.

dev

Validates miniapp.json, builds both layers, serves them over your LAN, and prints a QR (and a miniapp://dev?... URL). It also runs a dev sidecar WebSocket on the next port up for live reload and console-log forwarding back to your terminal (non-fatal if it can’t start). It watches for Wi-Fi/LAN-IP changes every 2 seconds and reprints the QR. The QR also carries an iroh ticket, so the phone can reach your computer from any network, directly or through n0’s public relays. The iroh identity is kept per package in ~/.glassly/dev-tunnel/, so a saved dev miniapp reconnects after you restart dev without a re-scan. Older Glassly App builds ignore the ticket and use the LAN URL. --no-iroh leaves it out, and on machines without an iroh binding (Intel Macs) the QR is LAN-only. If you are signed in with glassly login, dev also signs a dev identity for the miniapp so session.auth works against your backend during development. Pass --auth to fail instead of falling back when you are signed out. The starting port comes from "port" in miniapp.json (default 3000); if it or its sidecar neighbor is busy, the CLI scans upward for a free adjacent pair. --qr / -q sets the terminal QR size (small/sm, medium/md, large/lg; defaults to medium). --qr-output <path> writes the QR as a PNG to that path instead of a temp file that gets cleaned up on exit. On the phone, in the Glassly App, open Settings → Miniapp Developer Settings → Scan Miniapp QR Code. Ctrl+C stops everything.
dev is live and temporary. Keep the CLI and computer running: the Glassly App loads the runtime bundle from that LAN server. Dev miniapps are keyed by their manifest package name, so you can scan and test several side by side; rescanning the same package updates only that entry. The Glassly App caches each entry’s name and icon. Use bun run release for an installed miniapp that works without the computer.

sim

Runs the miniapp on your computer with no phone or glasses; see Simulator. It rebuilds and reloads on save. With --detach it prints the address and a log file path, and a simulator already running for the project is reused. The subcommands below talk to the simulator running for the current project (--cwd <path> for another project, --port <port> for a specific one). Screenshots use the @napi-rs/canvas binding. On a platform without one, everything else still works and sim screen remains available.

release

The all-in-one path for putting a build on real devices. It validates, builds, packs, and serves the result behind a QR so you can install on as many phones as you want. It reuses a cached build/<pkg>-<version>.gls when every source file is older than the zip, otherwise rebuilds (auto-detecting your package manager from the lockfile). It serves the bundle, manifest, and icon over HTTP on 0.0.0.0 and prints a miniapp://release?... QR, then stays up so multiple devices can install. Each install logs a line. Installed miniapps run offline and persist across restarts; no laptop needed after install. release takes the same --qr / -q and --qr-output <path> flags as dev.

build

Runs the project’s production build (bun run build, which executes your build.ts) so dist/background/index.js and dist/ui/* are current. pack, release, and publish all run this for you.

pack

Produces the distributable artifact only (release calls this internally). It builds with NODE_ENV=production, verifies dist/, validates the manifest, copies miniapp.json + icon.png into dist/, and zips to build/<pkg>-<version>.gls. A .gls file is a plain zip under the extension the Glassly App registers as its own, so it opens in the app when shared (see Distribution). It is also what publish uploads to the Glassly Miniapp Store.
pack requires the zip binary on PATH (preinstalled on macOS and most Linux; on Windows use WSL). build/ self-ignores from git.

manifest

An interactive wizard for miniapp.json: edit permissions and hardware requirements, show the current manifest, or finish. It saves after each confirmed change, so Ctrl+C never loses a saved edit.

permission and hardware

Object-verb edits that share the wizard’s validation:
Permission TYPE: MICROPHONE, CAMERA, CALENDAR, LOCATION, BACKGROUND_LOCATION, READ_NOTIFICATIONS, POST_NOTIFICATIONS, API_KEYS, MEMORY, AI, SPEAKERS, DISPLAY_MIRROR, MANAGE_MINIAPPS, PLATFORM_SETTINGS. Hardware TYPE: CAMERA, DISPLAY, MICROPHONE, SPEAKER, IMU, BUTTON, LIGHT, WIFI; LEVEL: REQUIRED, OPTIONAL. See the manifest for what each means.

schema

Prints the canonical miniapp.json JSON Schema to stdout: useful for CI validation or IDE config. The same schema ships at node_modules/@glassly/miniapp-cli/schema/miniapp.schema.json, which the $schema line in a scaffolded miniapp.json references for editor autocomplete.

login and logout

login signs you in to your Glassly developer account with a one-time device code: approve it on the sign-in page the CLI opens, and the CLI stores a session for the other Store commands. Your account, org, releases, and API keys are managed in the Developer Console. The session and the bundle signing key the CLI registers for you are stored per backend in ~/.glassly/cli/, readable only by your user. whoami shows the current login; logout removes it. Create your developer org in the console first, or from the terminal with glassly org init --name "Your Org" --prefix com.example (glassly org show prints it). The org owns the package prefix every miniapp you publish must start with.

Headless sign-in (CI and AI agents)

Where no one can approve a browser sign-in, use an API key instead of login. An org owner or admin creates one on the API keys page of the Developer Console; set it as CLI_TOKEN and the Store commands use it for that org:

publish

Run from the miniapp folder after glassly login. It reserves the package name for your org if needed, builds and packs, signs the bundle, uploads it with any store/ icon and screenshots, and submits the release for review. See Distribution for what happens next.

miniapps and releases

publish creates the package record and submits the release for you; these are for inspecting state or managing packages by hand.

listing and media

Listing overrides replace the tagline, description, and tags from miniapp.json on the Store card. Media uploads replace or extend the icon and screenshots that publish took from the bundle and the store/ folder.

feedback

Sends a report to the Glassly team with the CLI, SDK, and runtime versions and the package name from miniapp.json attached. No sign-in needed; if you are signed in, the report carries your account. Prints a rep_... report id. See Report a gap or bug for the options and the equivalent HTTP call.