whatisgithub

What is ui.md?

praeclarum/ui.md — explained in plain English

Analysis updated 2026-05-18

41Audience · vibe coderComplexity · 1/5LicenseSetup · easy

In one sentence

A single markdown file of opinionated UI design rules meant to be fed into a coding agent's context before it writes interface code.

Mindmap

mindmap
  root((ui.md))
    What it does
      Design rules for agents
      Prime directive
      Do and dont guidance
      Usability checklist
    Tech stack
      Plain markdown
      No code
    Use cases
      Guide a coding agent on UI
      Review shipped UI
      Standardize UI decisions
    Audience
      Vibe coders
      Developers using AI agents

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Drop this file into a coding agent's context before asking it to build a UI.

USE CASE 2

Use the checklist to sanity check UI an agent already shipped.

USE CASE 3

Standardize how a team's coding agents approach buttons, forms, and navigation.

USE CASE 4

Teach a coding agent to prioritize user expectations over feature completeness.

What is it built with?

Markdown

How does it compare?

praeclarum/ui.mdaaron-kidwell/gololabishek-kk/railmind-ai
Stars414141
LanguageGoTypeScript
Setup difficultyeasyeasyhard
Complexity1/52/55/5
Audiencevibe coderdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min
MIT licensed, meaning it can be reused freely for any purpose as long as the copyright notice is kept.

So what is it?

UI.md is not a piece of software you install or run. It is a single text file containing a concise, opinionated set of design rules meant to be handed to a coding agent, such as Claude Code, before it starts writing user interface code. The idea is to give the agent a design contract to follow so it thinks about good UI behavior before it starts producing UI code, rather than just satisfying a feature checklist afterward. Using it is simple: you include the UI.md file in the coding agent's context when starting any task that involves building or changing a user interface, and you treat its contents as rules the agent should actually follow, not just a functional requirement to check off. At the end of the file there is a checklist you can use afterward to sanity check whatever UI the agent produced. The file itself is organized into a few sections. It opens with what it calls a prime directive, the idea that a UI is good when it behaves the way the user expected it to. From there it lists design priorities such as matching the user's mental model, focusing on the activities people are trying to complete rather than piling on features, reducing the number of decisions a user has to make, staying consistent, making actions obvious, and favoring recognition over making users recall things. It follows this with practical do and don't guidance, low level rules covering specific elements like buttons, forms, dropdowns, navigation, text, and error messages, and finally the usability review checklist mentioned above. The project is released under the MIT license, which is permissive and allows free reuse as long as the copyright notice is kept.

Copy-paste prompts

Prompt 1
Include UI.md in my context and follow its rules while building this feature's interface.
Prompt 2
Review the UI I just built against the usability checklist in UI.md.
Prompt 3
Explain the design priorities in UI.md and how they apply to a form I'm designing.
Prompt 4
Summarize the low-level UI rules in UI.md for buttons and error messages.

Frequently asked questions

What is ui.md?

A single markdown file of opinionated UI design rules meant to be fed into a coding agent's context before it writes interface code.

What license does ui.md use?

MIT licensed, meaning it can be reused freely for any purpose as long as the copyright notice is kept.

How hard is ui.md to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is ui.md for?

Mainly vibe coder.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.