QuickStart
Welcome to AIUI! AIUI is an AI-native GUI local agent framework designed specifically for AI + AR. It emphasizes both agent-oriented interaction and organizational patterns, while also integrating local device-side capabilities to help developers build truly deployable intelligent agents. To help you develop agents more efficiently, we provide a complete documentation guide:
📖 How to Use This Documentation
You can switch between different functional modules through the top navigation bar:
- Quick Overview: If this is your first time working with AIUI, start here. It covers the core concepts of intelligent agents, the directory structure, and how to build your first agent.
- Agent Framework: Learn more about AIUI's runtime model, including configuration conventions (
AGENTS.md,app.json), framework structure (Pages, Widgets, and Agent Workers), and the WXML/WXSS reference documentation. - Components: Lists all UI components supported by AIUI in detail, such as
view,scroll-view,image, and more, together with their properties and usage. - API: Provides the JavaScript API reference for AIUI, including framework core APIs, open service APIs, multimedia APIs, network requests, and WeChat Mini Program-compatible APIs.
- Developer Tools: Introduces the AIUI developer tooling system, including the CLI and on-device debugging capabilities.
- Changelog: Learn about the latest features and fixes in AIUI.
In addition, you can choose different documentation versions from the upper-right corner of the page.
🚀 Next Steps
- Read the introduction: Understand the basic ideas behind AIUI.
- AIUI Quickstart: Get a quick overview of AIUI Studio AI CODEING development, debugging, submission for review, and release.
- Conversational AIUI: Start with card-based interaction inside the chat flow.
- Immersive AIUI: Start with complete interaction inside a standalone interface.
- Learn the directory structure: Get familiar with how a standard intelligent agent project is organized.
If you run into any issues during development, feel free to consult the relevant sections at any time.