AIUI

Build interactive agents for display-equipped AI glasses.

AIUI brings together documentation, a starter project, design guidance, examples, and developer skills for building agents on Rokid Glasses.

简体中文 · Quick start · Benchmark · Documentation · Examples · Awesome AIUI

Start building

npm create @yodaos-pkg/aiui-agent@latest my-agent

The starter contains app.js, app.json, AGENTS.md, and an Ink page at pages/index/index.ink. Follow the quick start for the Craft, AIUI Studio, and device debugging workflow.

AIUI Coding Benchmark

The AIUI Coding Benchmark measures how well an AI coding agent can create, modify, fix, and migrate AIUI projects. Its 50 tasks cover page state and events, Widgets, Workers, geolocation, storage, overlays, voice events, migration, and platform constraints. It also works as a regression suite for the aiui-dev skill.

Each task provides a description and a starting workspace. The grader checks the resulting source, manifest, and selected handler behavior: a task counts as resolved only when all required and regression checks pass with no constraint violations. The headline score is resolved tasks divided by graded tasks. The benchmark does not verify rendering or behavior on real glasses.

With Node.js 20 or later, explore the task catalog from the repository root without installing dependencies:

npm run bench:test
npm run --silent bench -- list
npm run --silent bench -- inspect 002-create-counter

See the benchmark guide to prepare a workspace, grade an agent's output, run the full suite, and compare model results.

Explore

Resource	What it offers
Documentation	Guides, components, APIs, tutorials, tools, and release notes in English and Chinese.
Samples	Runnable UI, device API, games, audio, scanner, and Bluetooth projects.
Design system	Monochrome display guidance and a green display preview.
Developer skill	AI coding guidance for Ink, components, APIs, and project structure.
Cloud integration	A Node.js package for third-party agents and Rokid Glasses notifications.
Coding benchmark	50 tasks, grading tools, and workflows for evaluating AIUI coding agents.

Start with the capabilities showcase, or explore focused gyroscope, device info, scanner, and text-to-speech examples.

Develop with an AI coding assistant

npx skills add https://github.com/jsar-project/AIUI/tree/main/skills/aiui-dev

The cloud integration skill covers notification workflows; the cloud APIs skill covers cloud API usage.

Repository map

Directory	Purpose
documentation/	Product and developer documentation
samples/	Runnable example agents
design/	Display design guidance
packages/create-aiui-agent/	Project scaffolding CLI
packages/cloud-integration/	Server-side cloud integration
skills/	AI coding instructions and references
bench/	AIUI coding benchmark

Help and feedback

Report a bug · Request a feature · Explore the ecosystem

Licensed under Apache 2.0.