Agent skill

Assistant UI

Guide for assistant-ui library - AI chat UI components. An agent skill from compozy/compozy.

MITAuto-check passedDevelopment

Install Assistant UI

skills CLI

$ npx skills add compozy/compozy --skill assistant-ui -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install compozy/compozy assistant-ui --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/compozy/compozy.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/assistant-ui/assistant-ui .claude/skills/assistant-ui && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "assistant-ui" agent skill from https://github.com/compozy/compozy/tree/main/.agents/skills/assistant-ui/assistant-ui into .claude/skills/assistant-ui/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "assistant-ui", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/compozy/compozy/tree/main/.agents/skills/assistant-ui/assistant-ui

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add compozy/compozy --skill assistant-ui -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install compozy/compozy assistant-ui --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/compozy/compozy.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/assistant-ui/assistant-ui .agents/skills/assistant-ui && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "assistant-ui" agent skill from https://github.com/compozy/compozy/tree/main/.agents/skills/assistant-ui/assistant-ui into .agents/skills/assistant-ui/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "assistant-ui", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add compozy/compozy --skill assistant-ui -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install compozy/compozy assistant-ui --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/compozy/compozy.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/assistant-ui/assistant-ui .cursor/skills/assistant-ui && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "assistant-ui" agent skill from https://github.com/compozy/compozy/tree/main/.agents/skills/assistant-ui/assistant-ui into .cursor/skills/assistant-ui/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "assistant-ui", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/compozy/compozy.git --path .agents/skills/assistant-ui/assistant-ui

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add compozy/compozy --skill assistant-ui -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install compozy/compozy assistant-ui --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/compozy/compozy.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/assistant-ui/assistant-ui .gemini/skills/assistant-ui && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "assistant-ui" agent skill from https://github.com/compozy/compozy/tree/main/.agents/skills/assistant-ui/assistant-ui into .gemini/skills/assistant-ui/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "assistant-ui", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install compozy/compozy assistant-ui

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add compozy/compozy --skill assistant-ui -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/compozy/compozy.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/assistant-ui/assistant-ui .github/skills/assistant-ui && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "assistant-ui" agent skill from https://github.com/compozy/compozy/tree/main/.agents/skills/assistant-ui/assistant-ui into .github/skills/assistant-ui/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "assistant-ui", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add compozy/compozy --skill assistant-ui -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install compozy/compozy assistant-ui --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/compozy/compozy.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/assistant-ui/assistant-ui .opencode/skills/assistant-ui && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "assistant-ui" agent skill from https://github.com/compozy/compozy/tree/main/.agents/skills/assistant-ui/assistant-ui into .opencode/skills/assistant-ui/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "assistant-ui", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: assistant-ui
GitHub stars: 2.8k
Token cost: ~958 tokens
SKILL.md length: 142 words
Files: 3 (incl. references)
Skills in repo: 47
Repo updated: Oct 8, 2026
First seen: Oct 7, 2026
Licence: MIT

At a glance

Guide for assistant-ui library - AI chat UI components. An agent skill from compozy/compozy.

Asking about architecture
SKILL.md covers References, When to Use, Architecture and Pick a Runtime, plus 4 more sections
Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
Understanding the codebase

What it does

Assistant UI is an agent skill from compozy/compozy. Guide for assistant-ui library - AI chat UI components. Use when asking about architecture, debugging, or understanding the codebase.

Its SKILL.md is about 960 tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including reference files (for example `references/architecture.md` and `references/packages.md`).

It sits in Development. It works with React. The repository describes itself as: An operating system for AI agents. Plug in the agent CLIs you already use (Claude Code, Codex, Gemini CLI, Cursor) and they become a team: they split the work, hand tasks to each… The licence is MIT.

When your agent uses it

Asking about architecture
Understanding the codebase

Example prompts

“/assistant-ui”

What it can do on your machine

Read from SKILL.md and the folder at commit eec2ed1. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are typescript).
From the folder's file list and the shell code blocks in SKILL.md.
Network
Links to these hosts (documentation or services it may open):
- assistant-ui.com
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Assistant UI loads about 958 tokens when it runs, and up to ~3.1k if it reads all its reference files. Until then it costs about 37 tokens; SKILL.md has 142 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~37
When it runs · the whole SKILL.md, loaded when a task matches: ~958
With references · SKILL.md plus every file in references/, read only if the agent opens them: ~3.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from compozy/compozy at commit eec2ed1, republished under its MIT licence (© compozy). 142 words, ~958 tokens.

Download SKILL.mdSave it as .claude/skills/assistant-ui/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.

name: assistant-ui
description: Guide for assistant-ui library - AI chat UI components. Use when asking about architecture, debugging, or understanding the codebase.
version: 0.0.1
license: MIT

assistant-ui

Always consult assistant-ui.com/llms.txt for latest API.

React library for building AI chat interfaces with composable primitives.

References

./references/architecture.md -- Core architecture and layered system
./references/packages.md -- Package overview and selection guide

When to Use

Use Case	Best For
Chat UI from scratch	Full control over UX
Existing AI backend	Connects to any streaming backend
Custom message types	Tools, images, files, custom parts
Multi-thread apps	Built-in thread list management
Production apps	Cloud persistence, auth, analytics

Architecture

┌─────────────────────────────────────────────────────────┐
│                  UI Components (Primitives)             │
│    ThreadPrimitive, MessagePrimitive, ComposerPrimitive │
└─────────────────────────┬───────────────────────────────┘
                          │
┌─────────────────────────▼───────────────────────────────┐
│                   Context Hooks                         │
│   useAui, useAuiState, useAuiEvent │
└─────────────────────────┬───────────────────────────────┘
                          │
┌─────────────────────────▼───────────────────────────────┐
│                    Runtime Layer                        │
│  AssistantRuntime → ThreadRuntime → MessageRuntime      │
└─────────────────────────┬───────────────────────────────┘
                          │
┌─────────────────────────▼───────────────────────────────┐
│                   Adapters/Backend                      │
│   AI SDK · LangGraph · Custom · Cloud Persistence       │
└─────────────────────────────────────────────────────────┘

Pick a Runtime

Using AI SDK?
├─ Yes → useChatRuntime (recommended)
└─ No
   ├─ External state (Redux/Zustand)? → useExternalStoreRuntime
   ├─ LangGraph agent? → useLangGraphRuntime
   ├─ AG-UI protocol? → useAgUiRuntime
   ├─ A2A protocol? → useA2ARuntime
   └─ Custom API → useLocalRuntime

Core Packages

Package	Purpose
`@assistant-ui/react`	UI primitives & hooks
`@assistant-ui/react-ai-sdk`	Vercel AI SDK v6 adapter
`@assistant-ui/react-langgraph`	LangGraph adapter
`@assistant-ui/react-markdown`	Markdown rendering
`assistant-stream`	Streaming protocol
`assistant-cloud`	Cloud persistence

Quick Start

tsx

import { AssistantRuntimeProvider } from "@assistant-ui/react";
import { Thread } from "@/components/assistant-ui/thread";
import { useChatRuntime, AssistantChatTransport } from "@assistant-ui/react-ai-sdk";

function App() {
  const runtime = useChatRuntime({
    transport: new AssistantChatTransport({ api: "/api/chat" }),
  });
  return (
    <AssistantRuntimeProvider runtime={runtime}>
      <Thread />
    </AssistantRuntimeProvider>
  );
}

State Access

tsx

import { useAui, useAuiState } from "@assistant-ui/react";

const api = useAui();
api.thread().append({ role: "user", content: [{ type: "text", text: "Hi" }] });
api.thread().cancelRun();

const messages = useAuiState(s => s.thread.messages);
const isRunning = useAuiState(s => s.thread.isRunning);

/setup - Installation and configuration
/primitives - UI component customization
/runtime - State management deep dive
/tools - Tool registration and UI
/streaming - Streaming protocols
/cloud - Persistence and auth
/thread-list - Multi-thread management
/update - Version updates and migrations

Files

SKILL.md and 2 other files (references) in .agents/skills/assistant-ui/assistant-ui of compozy/compozy.

SKILL.md
references/architecture.md
references/packages.md

Open the folder on GitHubat commit eec2ed1

Compare with similar skills

Assistant UI next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Assistant UI compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Assistant UI this skillcompozy/compozy	2.8k	—	~958	Automated safety check: Pass	MIT	today
Vercel Composition Patternssupabase/supabase	111k	59 repos	~726	Automated safety check: Pass	MIT	today
Electron Multi-Process ArchitectureiOfficeAI/AionUi	33k	1 repos	~1.8k	Automated safety check: Pass	Apache-2.0	29 days ago
Nx Generatenomcopter/react-mosaic	4.8k	7 repos	~1.9k	Automated safety check: Pass	Custom licence	9 days ago
@pierre/diffs Code Renderingpierrecomputer/pierre	6.2k	2 repos	~803	Automated safety check: Pass	Apache-2.0	today
OpenTUI Terminal Interfacescline/cline	70k	—	~1.9k	Automated safety check: Pass	Apache-2.0	today

Similar skills

Vercel Composition Patterns
supabase/supabase
Official
React composition patterns that scale. An agent skill from supabase/supabase.
111k GitHub starsUsed in 59 repos~726 tokens
DevelopmentAuto-check passed
Electron Multi-Process Architecture
iOfficeAI/AionUi
Tells the agent where new code belongs in an Electron multi-process project and which APIs each process may use, with rules for new bridges, services, agents and workers.
33k GitHub starsUsed in 1 repo~1.8k tokens
DevelopmentAuto-check passed
Nx Generate
nomcopter/react-mosaic
Generate code using nx generators. An agent skill from nomcopter/react-mosaic.
4.8k GitHub starsUsed in 7 repos~1.9k tokens
DevelopmentAuto-check passed
@pierre/diffs Code Rendering
pierrecomputer/pierre
Guides an agent through using @pierre/diffs to render syntax-highlighted files and diffs, and to build editing and review surfaces in React or plain JavaScript.
6.2k GitHub starsUsed in 2 repos~803 tokens
DevelopmentAuto-check passed
OpenTUI Terminal Interfaces
cline/cline
Helps build terminal user interfaces with OpenTUI using its core imperative API or its React and Solid reconcilers, with references for layout, keyboard, animation and testing.
70k GitHub stars~1.9k tokensUpdated today
DevelopmentAuto-check passed
Claude Code Skill
codeaashu/claude-code
Development conventions and architecture guide for the Claude Code CLI repository.
3.4k GitHub starsUsed in 1 repo~2.7k tokens
DevelopmentAuto-check passed

Questions about Assistant UI

What does Assistant UI do?

Guide for assistant-ui library - AI chat UI components. An agent skill from compozy/compozy. Assistant UI is an agent skill from compozy/compozy. Guide for assistant-ui library - AI chat UI components.

When should I use Assistant UI?

Assistant UI fits situations like: asking about architecture; understanding the codebase.

How do I install Assistant UI in Claude Code?

Run `npx skills add compozy/compozy --skill assistant-ui -a claude-code`. Or copy the skill folder (.agents/skills/assistant-ui/assistant-ui in compozy/compozy) into .claude/skills/assistant-ui in your project. Claude Code loads it when a task matches its description.

How do I install Assistant UI in Codex?

Run `npx skills add compozy/compozy --skill assistant-ui -a codex`. Or copy the skill folder (.agents/skills/assistant-ui/assistant-ui in compozy/compozy) into .agents/skills/assistant-ui in your project. Codex loads it when a task matches its description.

Can I use Assistant UI in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add compozy/compozy --skill assistant-ui -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/assistant-ui, .gemini/skills/assistant-ui, .github/skills/assistant-ui and .opencode/skills/assistant-ui in your project.

What does Assistant UI need to run?

SKILL.md names no scripts, command-line tools or credentials: Assistant UI is instructions for the agent only.

Does Assistant UI access the network?

SKILL.md names 1 domain. As links in the text: assistant-ui.com. This is read from the text; nothing was executed.

Is Assistant UI safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Assistant UI use?

Assistant UI is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Assistant UI use?

About 958 tokens (SKILL.md is roughly 3.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 2.1k tokens, read only when the agent opens those files.

What are the alternatives to Assistant UI?

Skills that share tags, products or a category with Assistant UI: Vercel Composition Patterns (supabase/supabase, 111k stars), Electron Multi-Process Architecture (iOfficeAI/AionUi, 33k stars), Nx Generate (nomcopter/react-mosaic, 4.8k stars) and @pierre/diffs Code Rendering (pierrecomputer/pierre, 6.2k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Assistant UI?

compozy (a GitHub organization) maintains it in compozy/compozy, which has 2,792 GitHub stars. The repository holds 47 skills in this directory. The repository was last updated on October 8, 2026.

Source: compozy/compozy on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Assistant UI

Install Assistant UI

Facts

At a glance

What it does

When your agent uses it

Example prompts

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

assistant-ui

References

When to Use

Architecture

Pick a Runtime

Core Packages

Quick Start

State Access

Files

Compare with similar skills

Similar skills

Vercel Composition Patterns

Electron Multi-Process Architecture

Nx Generate

@pierre/diffs Code Rendering

OpenTUI Terminal Interfaces

Claude Code Skill

More from compozy/compozy

Eng Real Scenario QA

Eng Test Conventions

Assistant UI Primitives

Assistant UI Runtime

Assistant UI Streaming

Assistant UI Tools

Questions about Assistant UI

Install Assistant UI

Facts

At a glance

What it does

When your agent uses it

Example prompts

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

assistant-ui

References

When to Use

Architecture

Pick a Runtime

Core Packages

Quick Start

State Access

Related Skills

Files

Compare with similar skills

Similar skills

More from compozy/compozy

Related

Questions about Assistant UI