openui-forge: Instructions file for Codex

AGENTS.md

openui-forge AGENTS.md is an instructions file for Codex, OpenCode from OthmanAdi/openui-forge. It costs 558 tokens per session, scanned A, original, MIT.

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

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md; mentions Codex; mentions OpenCode.

This is OthmanAdi/openui-forge's own configuration. It tells Codex and OpenCode how to work on openui-forge itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything openui-forge configures →

Reuse

Borrowing it

Nothing to install: this file belongs to OthmanAdi/openui-forge. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/OthmanAdi/openui-forge/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/OthmanAdi/openui-forge

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for openui-forge AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/othmanadi/openui-forge/agents-md/github.svg)](https://agentmods.dev/instructions/othmanadi/openui-forge/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/othmanadi/openui-forge/agents-md"><img src="https://agentmods.dev/badge/instructions/othmanadi/openui-forge/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for openui-forge AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/othmanadi/openui-forge/agents-md"><img src="https://agentmods.dev/badge/instructions/othmanadi/openui-forge/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
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. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00558 $0.00558
Opus 5.5 $0.00223 $0.00223
Sonnet 5.5 $0.00112 $0.00112
Haiku 4.5 $0.00056 $0.00056

Measured 1mo ago against content hash ea3aa1e8182b, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 1mo 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. 1mo 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 2mo ago), licensed MIT. It adds 558 tokens to every session, about $0.0022 per session on Opus 5.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.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,649 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,257 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,159 tokens