Docs

Getting Started

Create a new app with the CLI or install the runtime packages manually.

Raw Markdown

Getting Started

The fastest way to start is the CLI:

npm create mrbd-app@latest

The CLI asks for a project name, copies a Next.js starter template, and writes package metadata using that name.

Then run:

cd your-project-name
npm install
npm run dev

Open the app in a desktop browser and set DevTools to a 600x600 viewport. Use Arrow keys and Enter to test the same input model used by the glasses runtime.

The scaffold also installs mrbd-cli and adds an mrbd:start script. Use it when you want to test on glasses without deploying:

npm run mrbd:start

That starts your dev server when needed, opens a short-lived public HTTPS tunnel, and prints a URL with a QR code. See Tunnel Testing for options and security notes.

Add packages manually

For an existing React app:

npm install @mrbd/core @mrbd/react

For a non-React app:

npm install @mrbd/core

@mrbd/core is safe to import during server rendering. It checks for browser APIs when helpers are called.

Add sign-in

To let users sign in from the glasses, add @mrbd/auth:

npm install @mrbd/auth

It runs a glasses-owned OTP flow through MRBD-hosted auth and ships React components for the sign-in screen. See API: @mrbd/auth for the full flow.