openui-forge AGENTS.md

Repository instructions for openui-forge, a tool that adds OpenUI—the open standard for interfaces generated by language models—to existing projects. They cover supported frontends, backend connections, commands, and validation.

In plain words
What is it for?
Use them to detect project state, scaffold OpenUI, create validated components, connect an LLM backend, generate prompts, and run checks.
Why use it?
They tell coding agents which instructions and commands to follow when adding or changing OpenUI features.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/othmanadi/openui-forge/agents-md
Clone the repo
git clone --depth 1 https://github.com/OthmanAdi/openui-forge

Made for: Codex, OpenCode.

Per session 558 This file is loaded in full into every session.
When invoked 558 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00558 $0.00558
Opus 5 $0.00279 $0.00279
Sonnet 5 $0.00112 $0.00112
Haiku 4.5 $0.00056 $0.00056

Measured 2d ago against content hash ea3aa1e8182b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

openui-forge AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 32 lines

How it starts

The opening of the file, as written. The whole thing — 32 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

This repository is openui-forge, a cross-IDE agent skill for OpenUI, the Open Standard for Generative UI. It drops OpenUI into existing codebases across many stacks, any LLM provider, and multiple backend languages.

Start here

The full skill is skills/openui-forge/SKILL.md. Read it before doing any OpenUI work. Stack-specific variants live in skills/openui-forge-*/.

Commands

Command Purpose
/openui Detect project state, recommend the next action
/openui:scaffold Add OpenUI to an existing project, or scaffold a new one via the official CLI
/openui:component Create a component (Zod schema + framework renderer)
/openui:integrate Wire the LLM backend for the detected stack
/openui:prompt Generate the system prompt from the component library
/openui:validate Run the validation pipeline

What it covers

  • Frontends: React (most complete), Vue 3, Svelte 5, all on the framework-agnostic @openuidev/lang-core substrate.
  • TypeScript backends: OpenAI, Anthropic, LangChain / LangGraph, Vercel AI SDK.
  • Other backend languages: Python (FastAPI), Go (net/http), Rust (Axum), and more under skills/openui-forge/templates/.
  • Any OpenAI-compatible provider via OPENAI_BASE_URL (Gemini, OpenRouter, xAI, DeepSeek, Groq, Mistral, Ollama, and others).

Conventions for contributors and agents

  • The canonical source is skills/openui-forge/. The dotted directories (.claude/, .cursor/, .agents/, .gemini/, .codex/, .codebuddy/, .factory/, .opencode/, .pi/, .mastracode/) are mirrors generated by scripts/sync-platforms.{sh,ps1}. Edit the canonical copy, then run the sync.
  • Kiro and Continue do not read a skills/ directory. They are covered by this file plus .kiro/steering/openui-forge.md and .continue/rules/openui-forge.md.
  • Match the frontend streamProtocol to the backend body: SSE pairs with openAIAdapter(); NDJSON pairs with openAIReadableStreamAdapter().

Read the full file on GitHub · 32 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 32 lines · 558 tokens per session scan A ea3aa1e8182b

Subscribe to this mod's changes

openui-forge AGENTS.md is an instructions file published in the GitHub repository OthmanAdi/openui-forge (22 stars, last pushed 29d ago), licensed MIT. It adds 558 tokens to every session, about $0.0028 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.