README.md

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/simple/, a complete sample app that you can use to explore page structure, assets, helper modules, and feature demos in one place.

• pages/: Example pages covering a range of AIUI capabilities and UI patterns.
• assets/: Static resources used by the demos, such as images, SVGs, and audio files.
• lib/: Helper modules shared by sample pages.

Representative demos inside samples/simple/pages/ include:

• layout, grid, position: Layout and positioning patterns.
• image, list, input_textarea: Common UI building blocks.
• canvas, canvas_api, chart, lottie: Rendering and visual content examples.
• media_query, css_vars, filter, transform: Styling and responsive behavior examples.

🤖 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

• jsui-dev Skill: Located in skills/jsui-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.

📂 Repository Structure

.
├── packages/
│   └── create-jsui-agent/    # npm CLI for scaffolding AIUI agent projects
├── samples/
│   └── simple/               # runnable AIUI sample app and feature demos
├── skills/
│   └── aiui-dev/             # AI Agent skill documentation (SKILL.md)
└── .github/workflows/        # Automated daily build and publish workflows

📄 License

Apache License 2.0