AIUI Developer Tools & Skills

简体中文

This repository provides developer tools, CLIs, and AI agent skills for building applications on AIUI (Artificial Intelligence User Interface) — an agentic runtime designed for AI glasses with displays.

🚀 Quick Start

Create a new AIUI Agent

You can quickly scaffold a new AIUI Agent project using our official CLI tool. Run the following command and follow the prompts:

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

This will generate a ready-to-use AIUI project template including:

• app.js and app.json for global configuration.
• AGENTS.md for agent capability manifestation.
• A modern Single File Component (SFC) index.ink page setup.

🧪 Samples

The samples/ directory contains runnable example projects that demonstrate AIUI features and provide reference implementations for common UI patterns.

At the moment, the repository includes:

• samples/capabilities/: a complete sample app for page structure, assets, helper modules, and feature demos
• samples/pt-br/: the glasses' Brazilian Portuguese voice loop (Hi Rokid system language + ASR, LLM prompt, and TTS lang pinned to pt-BR)

To try the pt-BR glasses voice loop in Craft Global, import the publish branch below. Craft treats everything after /tree/ as a single git ref, so importing /tree/main/samples/pt-br fails:

https://github.com/pedrobastosribeiro/Rokid_AIUI/tree/pt-br

Open Craft Global, paste the URL, and click Run Agent. The branch root already contains app.json; do not merge pt-br into main. See samples/pt-br/README.md and samples/pt-br/CRAFT.md for language setup, packaging, and deployment.

📚 Documentation

The documentation/ directory contains the official AIUI docs in both Chinese and English. It covers onboarding, framework concepts, built-in components, runtime and Web-style APIs, design guidance, developer tools, and release notes.

• 0-guide/: Getting started, runtime basics, configuration, debugging, performance, and AIUI app structure.
• 1-framework/: Framework fundamentals including project structure, config, WXML, and WXSS.
• 2-components/: Built-in component references such as view, text, image, input, swiper, canvas, and more.
• 3-api/: API references for framework, AI, media, device, network, storage, and compatible Web/Weixin APIs.
• 4-design/: Interaction and visual design guidance.
• 5-tools/: CLI, Craft, and debugging tool documentation.
• 6-changelog/: Latest release notes and change history.

🎨 Design System

The design/ directory holds AIUI's visual design language specs, organized by display type:

• design/monochrome/ — specs for single-color display hardware. The active green variant targets RokidGlasses1 / RokidGlasses2, whose hardware can only reproduce one luminous green channel over pure black. Covers colors (one green across four opacity tiers), typography, spacing, radii, border widths, component chrome, and Do's & Don'ts.
  • design-system-green.md — full token spec.
  • preview-green.html — self-contained, browsable visual showcase (no build step).
• design/fullcolor/ — planned, for full-RGB display hardware. Not yet authored.

The design system currently applies only to single-green monochrome display devices. The design/ layout keeps the current green spec stable and leaves room for the planned full-color variant.

The same monochrome-green spec is also bundled inside the aiui-dev skill (see below), so AI agents generating AIUI code align with these tokens automatically.

🤖 AI Agent Skills

We provide built-in instructions and context files to help LLMs (Large Language Models) or AI coding assistants write AIUI code effectively.

Install via CLI

You can easily install the AIUI developer skill into your project using the npx skills add command. This will fetch the necessary context files and make them available to your AI coding assistant:

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

If you want to install a specific released version of the skill instead of the latest main branch, replace main with the desired tag name:

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

• aiui-dev Skill: Located in skills/aiui-dev/SKILL.md, this document contains comprehensive API references, project structure guidelines, and .ink SFC specifications. You can feed this file to your AI assistant to grant it the "skill" of developing AIUI applications.

Feedback

If you'd like to request a feature or report a bug, please use the GitHub issue templates:

• Feature Request
• Bug Report

Repository Structure

.
├── documentation/                  # official AIUI documentation (zh-CN / en-US)
├── design/
│   ├── README.md                       # design language index (by display type)
│   ├── monochrome/                     # single-color display specs
│   │   ├── README.md                   # monochrome variants (currently green)
│   │   ├── design-system-green.md      # AIUI monochrome-green token spec
│   │   └── preview-green.html          # browsable visual showcase (green)
│   └── fullcolor/                      # planned — full-RGB display specs
├── packages/
│   └── create-aiui-agent/    # npm CLI for scaffolding AIUI agent projects
├── samples/
│   ├── bluetooth/            # Bluetooth sample
│   ├── capabilities/         # runnable AIUI capabilities app and feature demos
│   ├── cut-card/             # card-cutting sample
│   ├── games/                # games sample
│   ├── meal-card/            # meal-card sample
│   ├── pt-br/                # Brazilian Portuguese glasses voice loop
│   ├── scanner/              # camera and barcode scanning sample
│   └── tts/                  # text-to-speech sample
├── skills/
│   └── aiui-dev/             # AI Agent skill documentation (SKILL.md)
└── .github/workflows/        # Automated daily build and publish workflows

📄 License

Apache License 2.0