Skip to content
Back to search

AGenUI

Native A2UI Renderer for iOS/Android/HarmonyOS. High performance streaming Generative UI. Custom Components, Styles and more.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/AGenUI/AGenUI with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/AGenUI/AGenUI'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/agenui--agenui/badge.svg)](/listings/agenui--agenui)

HTML

<a href="/listings/agenui--agenui"><img src="/api/listings/agenui--agenui/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

**One-command install (recommended)**

npx skills add AGenUI/AGenUI

Supports 55+ AI coding agent runtimes, including Claude Code, Cursor, Codex, Gemini CLI, Windsurf, GitHub Copilot, and more.

**Manual install**

git clone https://github.com/AGenUI/AGenUI.git
cp -r AGenUI/skills/a2ui-generation ~/.claude/skills/

> For other runtimes, copy the `skills/a2ui-generation/` directory to the corresponding skills directory (e.g. `~/.cursor/skills/`, `~/.codex/skills/`).

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 379 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <div align="center">
  2. # AGenUI
  3. **AGenUI is a high-performance A2UI SDK for building native generative UI experiences across iOS, Android, and HarmonyOS.**
  4. <img src="docs/images/hero.gif" alt="AGenUI streaming generative UI across iOS, Android, and HarmonyOS" width="640"/>
  5. [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
  6. [![Platform](https://img.shields.io/badge/Platform-iOS%20%7C%20Android%20%7C%20HarmonyOS-blue)](#)
  7. [![Android SDK](https://img.shields.io/badge/Android-API%2021%2B-green)](#)
  8. [![iOS](https://img.shields.io/badge/iOS-13%2B-lightgrey)](#)
  9. [![HarmonyOS](https://img.shields.io/badge/HarmonyOS%20NEXT-API%2017%2B-red)](#)
  10. [**Official Website**](https://genui.amap.com) · [**Quick Start**](docs/QuickStart.md) · [**API Reference**](docs/API.md) · [**Contributing**](CONTRIBUTING.md)
  11. English | [中文](README.zh-CN.md)
  12. </div>
  13. > This project is under active development and evolving rapidly. Contributions, feedback, and discussions are warmly welcome.
  14. ---
  15. ## What's New in v1.9.0
  16. > Released on 2026-11-13
  17. - (Core) Fixed static property write-back so the host can reset controls by resending their original values after user interaction.
  18. - (HarmonyOS) Fixed hybrid view ID collisions across `SurfaceManager` instances.
  19. ---
  20. ## What is AGenUI?
  21. **AGenUI** is an A2UI SDK that simultaneously supports iOS, Android, and HarmonyOS. Built on and fully implementing the [A2UI v0.9 protocol open-sourced by Google](https://github.com/google/A2UI), it renders the streaming data of LLM-generated interactive UI in real time on mobile devices. Under the hood, it is powered by a cross-platform **shared C++ core engine**, while the three-platform rendering engines consume the component protocol dispatched by the core engine and perform drawing using native system capabilities.
  22. **AGenUI** leverages native system UI capabilities to render **interactive cards, forms, lists, images, media players, and more**, delivering a high-performance, smooth user experience.
  23. <img src="docs/images/a2ui_rendering_effect.png" alt="A2UI components rendering showcase" height="720">
  24. ---
  25. ## Key Features
  26. - **Real-time streaming rendering** — structured component descriptions are generated by the LLM, arrive incrementally, and update in real time
  27. - **High performance** — native rendering on iOS, Android, and HarmonyOS, maintaining a 120 fps refresh rate in core scenarios such as page scrolling
  28. - **22 built-in components** — 18 A2UI protocol components + 4 SDK extension components
  29. - **Custom component API** — register and extend native components via the custom component API, so the LLM can emit component descriptions by component name
  30. - **Function Call integration** — register client-side tools/functions that the LLM can invoke on demand
  31. - **Design Token & theming** — unified Design Token system and theme modes across all three platforms
  32. - **Light / Dark mode** — built-in light/dark appearance switching
  33. ---
  34. ## Architecture
  35. AGenUI adopts a **shared C++ core engine + three-platform component rendering engines** design.
  36. The C++ layer implements capabilities shared across all three platforms, including streaming data parsing, virtual component tree management, render data caching, theme/style resolution, and component change diffing. The C++ layer synchronizes the parsed component protocol to the three-platform rendering engines to trigger drawing.
  37. <div align="center">
  38. <img src="docs/images/architecture.svg" alt="AGenUI SDK architecture" width="720"/>
  39. </div>
  40. ### Project Directory
  41. | Path | Contents |
  42. |---|---|
  43. | `core/` | C++ core engine — parser, differ, layout, Function Call framework |
  44. | `core/include/` | Public C++ API consumed by platform bridging layers |
  45. | `platforms/ios/` | iOS component renderer + Objective-C bridge |
  46. | `platforms/android/` | Android component renderer + JNI bridge |
  47. | `platforms/harmony/` | HarmonyOS component renderer + NAPI bridge |
  48. | `playground/` | Three-platform demo apps for development & debugging |
  49. | `scripts/` | Build scripts for each platform |
  50. ---
  51. ## Components
  52. <div align="center">
  53. <img src="docs/images/components.svg" alt="AGenUI built-in components" width="760"/>
  54. </div>
  55. ### A2UI Protocol Components
  56. The following 18 components implement the A2UI protocol specification and are supported on all three platforms.
  57. | Component | Description |
  58. |---|---|
  59. | `Text` | Styled text with variants (h1–h5, body, caption, etc.) |
  60. | `Image` | Network image with scale modes and rounded corners |
  61. | `Icon` | Icon rendered via Unicode / SVG mapping |
  62. | `Divider` | Horizontal or vertical separator |
  63. | `Video` | Native video player with seek and auto-hiding controls |
  64. | `AudioPlayer` | Audio player with progress bar |
  65. | `Button` | Tappable button that triggers Action events |
  66. | `Row` | Horizontal flex container |
  67. | `Column` | Vertical flex container |
  68. | `Card` | Shadowed card container |
  69. | `List` | Scrollable list with static or template-driven children |
  70. | `Tabs` | Tab bar with switchable panels |
  71. | `Modal` | Native dialog overlay |
  72. | `TextField` | Text input with optional validation |
  73. | `CheckBox` | Boolean toggle |
  74. | `Slider` | Numeric range input |
  75. | `ChoicePicker` | Single / multi-select picker |
  76. | `DateTimeInput` | Date and time picker |
  77. ### SDK Built-in Extension Components
  78. The following 4 components are bundled with the SDK but are not part of the A2UI protocol specification.
  79. | Component | Description |
  80. |---|---|
  81. | `Table` | Data table with Yoga sub-layout |
  82. | `Carousel` | Image / content carousel |
  83. | `Web` | Embedded WebView |
  84. | `RichText` | HTML rich text rendering |
  85. ### Playground Example Components
  86. The following 3 components are registered and applied in the Playground to demonstrate integrating custom components via the API.
  87. | Component | Description |
  88. |---|---|
  89. | `Chart` | Bar, line, and pie charts |
  90. | `Markdown` | Markdown rendering with streaming support |
  91. | `Lottie` | Lottie animation playback |
  92. You can register your own components at runtime using the same API — see the [Quick Start](#quick-start) section.
  93. ---
  94. ## Catalog File
  95. The repository root includes `agenui_catalog.json`, a **self-contained ([freestanding](https://github.com/google/A2UI/blob/main/docs/concepts/catalogs.md#freestanding-catalogs)) Catalog JSON Schema file** conforming to the [A2UI v0.9 specification](https://github.com/google/A2UI/blob/main/docs/concepts/catalogs.md). All external `$ref`s have been inlined — it can be used standalone with no external dependencies.
  96. **Coverage:**
  97. - **25 components**: 18 A2UI protocol standard components + 4 SDK built-in extension components (`Table`, `Carousel`, `Web`, `RichText`), plus 3 Playground example components (`Chart`, `Markdown`, `Lottie`)
  98. - **14 functions**: covering validation, formatting, logical operators, and URL navigation
  99. - **Shared type definitions**: includes all A2UI v0.9 standard types, as well as `Styles` (general style properties) and `TextStyles` (text-specific style properties) — both extended by AGenUI
  100. **How to use:**
  101. When integrating an LLM Agent, supply this file's content or its hosted URL as the `catalogId` in the `supportedCatalogIds` field of [A2UI ClientCapabilities](https://github.com/google/A2UI/blob/main/docs/concepts/catalogs.md#a2ui-catalog-negotiation). The Agent will use this Schema as a constraint to generate strictly conformant A2UI JSON messages, ensuring the renderer correctly parses and renders all dispatched UI components.
  102. ---
  103. ## A2UI Generation Skill
  104. The `skills/a2ui-generation/` directory ships a standalone **A2UI generation Skill** that can be mounted into any Agent that supports the [Agent Skills](https://www.anthropic.com/engineering/equipping-agents-for-the-real-world-with-agent-skills) mechanism (e.g. Claude Code, Cursor, Codex, Gemini CLI, Windsurf, GitHub Copilot, etc.). It guides the LLM — via the Skill's built-in design rules and constraints — to turn a natural-language query into A2UI protocol messages (`updateComponents` / `updateDataModel`) that AGenUI can render directly.
  105. ### Installation
  106. **One-command install (recommended)**
  107. ```bash
  108. npx skills add AGenUI/AGenUI
  109. ```
  110. Supports 55+ AI coding agent runtimes, including Claude Code, Cursor, Codex, Gemini CLI, Windsurf, GitHub Copilot, and more.
  111. **Manual install**
  112. ```bash
  113. git clone https://github.com/AGenUI/AGenUI.git
  114. cp -r AGenUI/skills/a2ui-generation ~/.claude/skills/
  115. ```
  116. > For other runtimes, copy the `skills/a2ui-generation/` directory to the corresponding skills directory (e.g. `~/.cursor/skills/`, `~/.codex/skills/`).
  117. ### How to use
  118. After installation, describe the UI you want through a query in your agent. The Skill drives the LLM to emit A2UI v0.9–conformant JSON protocol.
  119. ### Layout & styling
  120. - **Default shape**: a single **Card**, focused on the essential information.
  121. - **Custom layout & styling**: your query can explicitly request other shapes (full page, list, table, etc.) or specific visual requirements (palette, spacing, font sizes, theme). When your explicit instruction conflicts with the Skill's defaults, the explicit instruction wins.
  122. ### LLM selection
  123. Different LLMs may produce somewhat different results when generating A2UI output. We recommend trying a few models against your own scenarios and picking the one that fits best.
  124. ## AGenUI Studio
  125. AGenUI Studio is a local, **bring-your-own-key** workbench that turns natural-language descriptions into renderable A2UI protocol — with a browser UI for streaming generation, live protocol preview, validation, and one-tap push to the AGenUI Playground on a real device via QR code. It builds on the open-source [A2UI generation Skill](skills/a2ui-generation) (reusing its design rules and validator) and supports multiple LLM providers (DeepSeek, Qwen, GLM, OpenAI, Gemini, and more) and runs entirely on your machine.
  126. ```bash
  127. npx agenui-studio
  128. ```
  129. 👉 See [playground/studio/README.md](playground/studio/README.md) for installation, configuration, and architecture details.
  130. ---
  131. ## Quick Start
  132. ### Toolchain Requirements
  133. | Platform | Toolchain |
  134. |---|---|
  135. | Android | Android Studio Hedgehog+, NDK 27.3.13750724, API 35 SDK, JDK 11 |
  136. | iOS | Xcode 15+, CocoaPods, CMake |
  137. | HarmonyOS | DevEco Studio 4.0+, ohpm |
  138. ### Building from Source
  139. All build scripts live in the `scripts/` directory. The C++ engine in `core/` is compiled automatically — no separate preparation step is needed.
  140. **Android**
  141. ```bash
  142. # Release AAR (default)
  143. ./scripts/android/build.sh
  144. # Debug AAR
  145. ./scripts/android/build.sh --debug
  146. # Release AAR + native debug-symbol companion (see "Native debug symbols" below)
  147. ./scripts/android/build.sh --with-symbols
  148. # Publish to local Maven (~/.m2)
  149. ./scripts/android/build.sh --publish-local
  150. # Publish debug AAR to local Maven
  151. ./scripts/android/build.sh --debug --publish-local
  152. # Publish to remote Maven (requires MAVEN_URL / MAVEN_USERNAME / MAVEN_PASSWORD env vars)
  153. ./scripts/android/build.sh --publish-maven
  154. # Clean before building
  155. ./scripts/android/build.sh --clean
  156. ```
  157. The AAR is written to `dist/android/release/`.
  158. **Native debug symbols (Android, opt-in)**
  159. For symbolicating release crashes on the host, run `./scripts/android/build.sh --with-symbols`. The release build then:
  160. 1. Skips `-Wl,--strip-all` so the linker output retains DWARF info.
  161. 2. Splits DWARF into a sibling `lib<name>.so.debug` via `objcopy --only-keep-debug` (CMake POST_BUILD), then strips the `.so` and links them via `.gnu_debuglink`.
  162. 3. Packages the `.so.debug` files into `<rootProject.name>-symbols.aar` alongside the regular release AAR, under `build/outputs/aar/`.
  163. The release AAR size is unaffected — AGP strips the `.so` before packaging anyway. The `.so.debug` suffix follows the GNU/LLVM convention (objcopy's default debug extension) and has no relation to Android's `debug` buildType.
  164. To symbolicate a crash address, unzip the symbols AAR and feed `.so.debug` to standard tools:
  165. ```bash
  166. unzip -j <name>-symbols.aar 'jni/arm64-v8a/*.so.debug' -d ./symbols/
  167. # Single address
  168. $ANDROID_NDK/toolchains/llvm/prebuilt/<host>/bin/llvm-addr2line \
  169. -e ./symbols/lib<name>.so.debug -f -C 0xADDR
  170. # Full backtrace from logcat
  171. $ANDROID_NDK/toolchains/llvm/prebuilt/<host>/bin/ndk-stack \
  172. -sym ./symbols/ -dump crash.log
  173. ```
  174. The flag is OFF by default — open-source builds see no change unless explicitly enabled.
  175. **iOS**
  176. ```bash
  177. # XCFramework (Release, default)
  178. ./scripts/ios/build.sh
  179. # Single-arch Framework, Debug
  180. ./scripts/ios/build.sh -t framework -c Debug
  181. # Force pod install then build
  182. ./scripts/ios/build.sh --pod-install
  183. ```
  184. **HarmonyOS**
  185. ```bash
  186. # HAR package (Release, default)
  187. ./scripts/harmony/build.sh
  188. # Debug build
  189. ./scripts/harmony/build.sh --mode debug
  190. # Custom output directory
  191. ./scripts/harmony/build.sh -o /path/to/output
  192. ```
  193. ### Debugging with the Playground
  194. A standalone Playground project is provided for each platform under `playground`. You can open and run any Playground project to experience the full A2UI component rendering. Each Playground references the AGenUI source code directly, so breakpoint debugging is supported.
  195. **Android Playground**
  196. - Open `playground/android/` with Android Studio
  197. - Let Gradle install dependencies and index the source files
  198. - Switch dependency mode via `gradle.properties`:
  199. ```
  200. # Source mode: changes to the C++ engine and the Android renderer take effect immediately
  201. agenui.sdk.source=true
  202. # AAR mode: no longer references source; consumes the pre-packaged SDK build (recommended only when debugging the Playground itself)
  203. agenui.sdk.source=false
  204. ```
  205. **iOS Playground**
  206. - Enter the `playground/ios/Playground` directory
  207. - Run `pod install` to install dependencies and generate the Xcode workspace; on success, `Playground.xcworkspace` will be generated under `playground/ios/Playground`
  208. - Open `Playground.xcworkspace`, pick a simulator, and build & run
  209. *`Playground.xcworkspace` already contains both the AGenUI source and the Playground target*
  210. **HarmonyOS Playground**
  211. - Open the `playground/harmony` directory with DevEco Studio
  212. - Let it install dependencies and index the source files
  213. - Pick a simulator, and build & run
  214. *The project references `platforms/harmony/agenui/` via `srcPath`, so any change to the AGenUI source is automatically picked up by the next build*
  215. ### Integrating the AGenUI SDK
  216. For details on building the source into a directly integrable artifact (see [Building from Source](#building-from-source)) and integrating it into your application, please refer to:
  217. > SDK installation & usage guide: [Quick Start](docs/QuickStart.md)
  218. >
  219. > Complete SDK API reference: [API Reference](docs/API.md)
  220. ---
  221. ## Contributing
  222. Contributions of all kinds are welcome — bug fixes, new components, platform improvements, documentation, and test coverage.
  223. Before submitting a pull request, please read [CONTRIBUTING.md](CONTRIBUTING.md) for the full workflow, code style guidelines (C++, Swift, and Java follow the Google Style Guide; ArkTS follows the OpenHarmony conventions), and the PR checklist.
  224. **Quick summary:**
  225. 1. Fork the repo and create a branch from `main`: `fix/123-my-fix` or `feat/my-feature`
  226. 2. Make your changes and add tests where appropriate
  227. 3. Build and test locally on the affected platform(s)
  228. 4. Open a PR against `main` with a clear description of *what* and *why*
  229. 5. At least one maintainer approval is required before merging
  230. For larger changes — new platform support, significant engine refactors, new component categories — please open an issue first to align on the approach before writing code.
  231. ---
  232. ## Community & Contact
  233. - **GitHub Issues**: [bug reports and feature requests](https://github.com/AGenUI/AGenUI/issues)
  234. - **GitHub Discussions**: [Q&A and general discussions](https://github.com/AGenUI/AGenUI/discussions)
  235. - **Email**: [tengjixiang.ttjx@alibaba-inc.com](mailto:tengjixiang.ttjx@alibaba-inc.com)
  236. - **DingTalk Group**: Chinese community
  237. - **WeChat Group**: Chinese community
  238. <div align="center">
  239. <table>
  240. <tr>
  241. <th>DingTalk Group</th>
  242. <th>WeChat Group</th>
  243. </tr>
  244. <tr>
  245. <td align="center"><img src="https://raw.githubusercontent.com/AGenUI/AGenUI/main/docs/images/dingtalk_qrcode.jpg" alt="AGenUI DingTalk group QR code" width="220"></td>
  246. <td align="center"><img src="https://raw.githubusercontent.com/AGenUI/AGenUI/main/docs/images/wechat_qrcode.jpg" alt="AGenUI WeChat group QR code" width="220"></td>
  247. </tr>
  248. </table>
  249. </div>
  250. ---
  251. ## License
  252. AGenUI is released under the [Apache License, Version 2.0](LICENSE).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.