Skip to content

ardamoustafa1/DesignOS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4,095 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DesignOS

The Design Intelligence Operating System for AI Coding Agents

Your AI agent writes flawless code. Now teach it taste.

Claude · Cursor · Copilot · Windsurf · Cline · Aider — any agent. One prompt in, Stripe-grade UI out.

GitHub stars License: MIT Version Live proof Validate WCAG 2.2 AA Zero dependencies Claude Code plugin Industry packs PRs welcome

Animated demo: prompt enters → DesignOS boots kernel v2.1.0 → routes landing/hero/persuasion modules → loads project memory → runs design loop → catches contrast failure → auto-fixes to 6.28:1 contrast → re-scores UI 96 · UX 97 · A11y 96 · Perf 97 all ≥ 95 → ships with memory written.

Get started · How it works · Live generator · Architecture · Enterprise guide · Governance · Before/After demo · Live showcase · Measured results · The Museum

Türkçe · 中文 · Español · 日本語 · Deutsch · Français · Português

Translations are LLM-authored, unreviewed by native speakers — corrections welcome via PR.


Start here

DesignOS is a repository-native design intelligence layer for AI coding agents. It adds the part a code model usually lacks: a repeatable way to understand the brief, derive a distinct visual direction, select relevant design knowledge, inspect the rendered result, and remember decisions across sessions.

It is not a component library and it does not replace your framework. It sits beside your codebase as Markdown instructions, specialist roles, workflows, validators, and a small zero-dependency CLI.

The short version: install once, verify the connection, then describe the interface you want. DesignOS routes the task through the right modules and leaves an inspectable trail of decisions, findings, and project memory.

What changes after installation?

Without a design operating system With DesignOS
The agent jumps from request to JSX The brief becomes a testable design contract first
“Premium” becomes gradients and cards Visual direction is derived from product material and brand belief
Every session starts from zero Seven memory files preserve brand and system decisions
The author grades its own work informally Specialist review, static checks, and an evidence ledger separate creation from verification
Happy-path mockups look finished Loading, empty, error, success, keyboard, responsive, and reduced-motion states are considered
References become style imitation DesignOS transfers tactics while prohibiting branded motifs
Table of contents

⚡ Quick Start

Fastest path — Claude Code plugin (two commands)

Inside any Claude Code session:

/plugin marketplace add ardamoustafa1/DesignOS
/plugin install designos@designos

The designos skill then activates automatically on any UI/design request — no slash command needed. It routes through the kernel, loads only the relevant modules, and runs the deterministic gate before any score claim.

Full install — repository-native (all agents + CLI)

Run the installer from the root of the project you want DesignOS to guide — not from inside a DesignOS clone.

cd path/to/your-project
npx github:ardamoustafa1/DesignOS init --agents --skills

The installer creates a local ./DesignOS copy, connects the Claude kernel, and optionally installs the nine specialist agents and four /design-* commands.

your-project/
├── DesignOS/                 design knowledge, workflows, CLI, validators
├── CLAUDE.md                 imports @DesignOS/CLAUDE.md
├── .claude/
│   ├── agents/               9 specialist roles
│   └── commands/             /design-brief · /design-review · /design-score · /design-tokens
└── your existing app files   untouched by installation

2. Verify the connection

All commands after installation use the local CLI copy:

node DesignOS/bin/designos.js doctor

A healthy setup confirms the kernel, local CLI, import, agents, skills, and project-memory status. If your agent is not Claude Code, export its native rules file next.

Warning

Never run bare npx designos .... That npm name belongs to an unrelated package. Use the GitHub installer once, then always use node DesignOS/bin/designos.js ....

3. Give it a real brief

Design a pricing page for a cybersecurity SaaS.

Audience: security leaders comparing vendors before a technical evaluation.
Primary action: book a technical demo.
Product material: risk timeline, asset table, and investigation workflow.
Proof available: real dashboard screenshots; no customer logos yet.
Tone: calm, precise, high-trust. Dark theme, but no neon cyber clichés.
Stack: use the existing project stack and tokens.

A strong brief gives DesignOS material to derive from. If details are missing, the Brief Compiler asks only high-impact questions or records explicit assumptions instead of silently inventing facts.

4. Review the result

node DesignOS/bin/designos.js audit src/
node DesignOS/bin/designos.js review src/ --fix-prompt --no-fail
node DesignOS/bin/designos.js visual path/to/page.html --no-fail
node DesignOS/bin/designos.js report src/ --no-fail

review reports static source risks. It is intentionally not presented as proof of visual quality, WCAG conformance, performance, or conversion. Final claims require the evidence ledger.


Choose your agent

The knowledge system is shared; the connection step differs by tool.

Agent After init What it creates Capability
Claude Code Nothing else required CLAUDE.md, specialist agents, slash commands Full kernel + native subagents/commands
Codex, Gemini CLI, Amp, Zed, Jules export agentsmd AGENTS.md Kernel through the agents.md convention
Cursor export cursor .cursorrules Kernel rules in project context
GitHub Copilot export copilot .github/copilot-instructions.md Repository instructions
Windsurf export windsurf .windsurfrules Workspace rules
Cline export cline .clinerules Project rules
Aider export aider CONVENTIONS.md Repository conventions
# Choose one, or generate every supported rules file:
node DesignOS/bin/designos.js export agentsmd
node DesignOS/bin/designos.js export cursor
node DesignOS/bin/designos.js export copilot
node DesignOS/bin/designos.js export windsurf
node DesignOS/bin/designos.js export cline
node DesignOS/bin/designos.js export aider
node DesignOS/bin/designos.js export all

Existing non-DesignOS rules files are protected by default. The exporter warns instead of overwriting them; review the integration guide before using --force.

Manual installation
git clone https://github.com/ardamoustafa1/DesignOS.git
cd path/to/your-project
cp -r path/to/DesignOS ./DesignOS
echo "@DesignOS/CLAUDE.md" >> CLAUDE.md

# Optional Claude Code integrations
cp DesignOS/agents/*.md .claude/agents/
cp DesignOS/skills/design-*.md .claude/commands/

Run node DesignOS/bin/designos.js doctor afterwards. For non-Claude agents, use the appropriate export command rather than hand-copying the kernel.

Global installation
cp -r path/to/DesignOS ~/.claude/DesignOS
echo "@~/.claude/DesignOS/CLAUDE.md" >> ~/.claude/CLAUDE.md

Local project installation is recommended when teams need versioned, reproducible rules.


Create your first interface

There are three good entry points. Pick the one that matches how much you already know.

A. Ask naturally

Build a premium landing page for an AI incident-response product.
Use our existing stack. The hero must show the real investigation timeline.
Primary action is starting a sandbox. Do not invent logos, metrics, or compliance claims.
Run the full DesignOS loop and show what was not verified.

B. Generate a structured brief

node DesignOS/bin/designos.js brief --interactive

Or create one non-interactively:

node DesignOS/bin/designos.js brief \
  --type pricing \
  --industry fintech \
  --audience "finance operations leaders" \
  --goal "start a guided trial" \
  --tone "precise, calm, evidence-first" \
  --constraints "existing React stack, light theme, WCAG 2.2 AA target"

C. Use a ready-made recipe

Start from recipes for common surfaces:

Each recipe is a high-signal brief, not an alternate mini-kernel. It still boots the same DesignOS process, originality discipline, render inspection, and evidence rules.


🔍 How It Works

DesignOS makes the design process observable. One request moves through a fixed control flow; findings return to the stage that caused them.

flowchart TB
    A["Your brief"] --> B["Kernel boots"]
    B --> C["Brief Compiler<br/>intent · audience · truth · constraints"]
    C --> D["Router<br/>task × sector × surface"]
    D --> E["Relevant modules + project memory"]
    E --> F["Research + 3 design directions"]
    F --> G["Wireframe + UI implementation"]
    G --> H["Render and inspect<br/>375 · 768 · 1024 · 1440"]
    H --> I["Specialist review<br/>creative · a11y · engineering"]
    I --> J{"Evidence-backed gate"}
    J -- "finding" --> K["Route to responsible stage"]
    K --> F
    J -- "verified" --> L["Artifact + rationale + memory updates"]
Loading

The loop, stage by stage

Stage Question answered Concrete output
Contract What must this cause, for whom, using what truth? Intent, audience state, proof/assets, never-list, acceptance evidence
Directions What could make this product unmistakable? Material-led, audience-led, and belief-led hypotheses
Wireframe In what order should attention move? Section structure, eye path, primary action, responsive priorities
UI What system expresses that hierarchy? Tokens, type, spacing, components, states, motion
Render/Inspect Does the real artifact match the source-code intention? Viewport evidence, visual findings, corrected implementation
Specialist review Is it coherent, usable, accessible, fast, and truthful? Findings with owner and severity
Final Gate What was actually checked? Static risk output + evidence ledger + NOT ASSESSED disclosures
Memory What must the next session remember? Durable decisions, status, bugs, and open work

Read the complete contracts in the Design Loop and the Final Gate.


System architecture

DesignOS uses a small kernel and lazy-loads detailed modules only when they change a decision. This keeps the agent focused instead of flooding its context with every rule.

flowchart LR
    K["Kernel<br/>CLAUDE.md · AGENTS.md"] --> R["Router"]
    R --> B["Brain<br/>intent · decisions · originality"]
    R --> N["Knowledge<br/>foundations · components · patterns"]
    R --> S["Sector intelligence<br/>24 industry playbooks"]
    B --> P["Process<br/>loops · workflows · agents"]
    N --> P
    S --> P
    M["Project memory<br/>7 durable files"] <--> P
    P --> Q["Quality<br/>rubric · checklists · validators"]
    Q --> O["Artifact + evidence + rationale"]
Loading

The seven layers

Layer Responsibility Explore
Kernel Boot order, routing table, non-negotiable standards CLAUDE.md · AGENTS.md
Design brain Intent, decision rules, taste, originality, reference transfer brain
Knowledge Foundations, components, patterns, motion, psychology, native UI foundations · components · patterns
Sector intelligence Buyer psychology, trust requirements, visual licenses industries
Process Design/review loops, workflows, and specialist roles loops · workflows · agents
Memory Brand, system, pages, tasks, bugs, notes memory
Evidence Rubric, checklists, static validators, eval protocol scoring · checklists · validators · evals
Repository map
DesignOS/
├── CLAUDE.md · AGENTS.md       kernel and routing
├── brain/                       design reasoning and originality
├── foundations/                color, type, spacing, layout, tokens, a11y
├── components/                 UI component intelligence
├── patterns/                   page and flow patterns
├── psychology/                 attention, persuasion, trust, cognition
├── motion/ · native/           motion and platform-native guidance
├── industries/                 24 sector playbooks
├── agents/                     9 specialist roles
├── loops/ · workflows/         production and review processes
├── scoring/ · checklists/      review rubric and evidence requirements
├── validators/                 zero-dependency static checks
├── memory/                     protocol, templates, personality packs
├── references/ · goldens/      reference tactics and target bars
├── starter/ · recipes/         executable starting points
├── examples/ · website/        inspectable demonstrations
├── evals/ · case-studies/      measurement and field evidence
└── bin/designos.js             installer and local CLI

Project memory

Without memory, every new chat can quietly change the brand, spacing scale, terminology, or page goals. DesignOS persists the reasoning, not only the final values.

flowchart TD
    C["client.md<br/>audience · goals · constraints"] --> D["design work"]
    B["brand.md<br/>voice · type · color · never-list"] --> D
    S["design.md<br/>tokens · layout · motion · overrides"] --> D
    D --> P["pages.md<br/>inventory · intent · status"]
    D --> T["todo.md<br/>prioritized open work"]
    D --> G["bugs.md<br/>known defects"]
    D --> N["notes.md<br/>assumptions · feedback · review history"]
    P --> NEXT["next session"]
    T --> NEXT
    G --> NEXT
    N --> NEXT
Loading

Bootstrap the seven files from memory/templates and follow the memory protocol: decisions carry reasons, dates are absolute, overrides are explicit, and superseded reasoning is preserved instead of erased.


CLI reference

Every command runs from your project root after installation.

Command Purpose Writes files?
doctor Verify kernel, CLI, integrations, skills, and memory No
export <agent> Generate the selected agent's rules file Yes
brief Produce a structured, agent-ready design brief Optional
suggest <brief> Deterministic design-system recommendation: sector + surface routing, contrast-verified palette (ratios computed at output time), type pairing, anti-patterns No
starter <name> <dir> Copy a production-oriented starter Yes
audit <target> Run token-drift, accessibility-basics, and token-pair contrast validators No
review <target> Report static design risks; optionally create a fix prompt No
visual <target> Create screenshot/static visual QA evidence Yes
elevate <target> Generate a premium-refactor prompt Yes
report <target> Create a delivery report and sign-off ledger Yes
eval <slug> Scaffold a controlled evaluation run Yes
case <slug> Scaffold a case study and showcase entry Yes
node DesignOS/bin/designos.js doctor
node DesignOS/bin/designos.js export all
node DesignOS/bin/designos.js brief --interactive
node DesignOS/bin/designos.js starter landing-page my-launch
node DesignOS/bin/designos.js audit src/
node DesignOS/bin/designos.js review src/ --fix-prompt --no-fail
node DesignOS/bin/designos.js visual index.html --no-fail
node DesignOS/bin/designos.js elevate src/ --no-fail
node DesignOS/bin/designos.js report src/ --no-fail
node DesignOS/bin/designos.js eval cursor-pricing --agent Cursor --brief B-001
node DesignOS/bin/designos.js case acme-pricing --project "Acme Pricing" --url https://example.com

Run node DesignOS/bin/designos.js help for flags and usage. The CLI has no runtime dependencies beyond Node.js 18+.


Quality and evidence

DesignOS reviews seven dimensions. The written rubric sets the quality language; the evidence ledger records which checks actually happened.

Dimension What the reviewer attacks Typical evidence
UI Craft Type, spacing, color, alignment, tokens, detail consistency Source inspection + rendered viewports
UX & Flow Eye path, cognitive load, conventions, state completeness Flow walk + responsive/state evidence
Accessibility Contrast, keyboard, semantics, reflow, announcements, motion Tools + manual keyboard/tree checks
Performance LCP, CLS, INP, payloads, fonts, images, animation cost Lighthouse/CWV measurement
Modernity Current craft without trend cosplay Reference comparison + creative review
Conversion Claim, mechanism, proof, objections, ask, friction, honesty Content/proof audit + task completion
Brand Fit & Distinctiveness Product derivation, signature, swap resistance Derivation chain + logo-swap/recall review
flowchart LR
    A["Source checks"] --> E["Evidence ledger"]
    B["Rendered viewports"] --> E
    C["Keyboard · a11y · motion"] --> E
    D["Performance + human review"] --> E
    E --> F{"Every applicable row assessed?"}
    F -- "No" --> G["Report NOT ASSESSED"]
    F -- "Yes" --> H["Apply scoring rubric"]
Loading

Important

A clean static review result means the configured source-risk checks found nothing. It does not by itself prove WCAG conformance, visual excellence, Lighthouse scores, or conversion performance. Read Proof Standard, Final Gate, and Known Limitations before publishing a quality claim.

What is mechanically checked today?

  • token drift and off-grid spacing risks
  • common semantic and accessible-name mistakes
  • missing landmarks/headings and suspicious focus removal
  • raw color usage outside token/exception boundaries
  • common fake-proof and hard-compliance claim risks
  • thin state coverage heuristics
  • optional browser screenshots and basic overflow/render checks

The complete design review remains broader than these static checks. Unverified dimensions stay NOT ASSESSED rather than becoming an invented score.


Examples and starters

See the system applied

Resource What to inspect
Live generator Type a brief in the browser → sector/surface routing + a palette whose WCAG ratios are computed on the page, live
Before / After The same brief with visible anti-pattern annotations
Live showcase Landing, dashboard, pricing, and docs on one token system
Landing walkthrough Decisions and failures behind the landing page
Dashboard walkthrough Density, hierarchy, tables, charts, and states
Pricing walkthrough Plan choice, trust, proof, and conversion logic
Docs walkthrough Information architecture and developer experience
Goldens Target bars for premium output categories
Anti-Pattern Museum Recognizable design failures and preventing rules

Start with working files

node DesignOS/bin/designos.js starter list
node DesignOS/bin/designos.js starter landing-page my-launch
node DesignOS/bin/designos.js starter next-saas my-app
node DesignOS/bin/designos.js starter react-dashboard operations-console
node DesignOS/bin/designos.js starter docs-site developer-docs
node DesignOS/bin/designos.js starter mobile-app mobile-onboarding

Browse all starters, copy-ready recipes, visual reference packs, and the one-page cheatsheet.


Troubleshooting

The agent ignores DesignOS

Run doctor. Confirm the correct rules file exists for your agent and that ./DesignOS has not been moved. For Claude Code, CLAUDE.md must contain @DesignOS/CLAUDE.md.

The output still looks generic

Give the brief product material, real assets, a brand belief, and a never-list. Ask the agent to show the three design directions before implementation and name the chosen signature's derivation chain. See Brief Compiler and Originality.

The CLI says the target does not exist

Run commands from the project root and pass a path relative to that root. review accepts supported UI source files or directories; visual expects an HTML file or URL.

An export would overwrite my existing rules

DesignOS protects non-generated rules files. Merge the instructions intentionally or back up the file before using --force. See integrations.

I accidentally ran npx designos

That package is unrelated. Review any changes it made, then reinstall with npx github:ardamoustafa1/DesignOS init --agents --skills and use the local Node command.

For a longer onboarding and diagnostic guide, read Getting Started.


Community

DesignOS becomes more credible through inspectable work, independent runs, and challenged rules — not through louder claims.

Project guides: Roadmap · Security · Enterprise · Governance · Code of Conduct · Press kit


License

MIT — see LICENSE. Use it, fork it, adapt it, and document what you learn.

Build interfaces that can explain every decision.

DesignOS is open source. The strongest contribution is evidence from real use.

About

Design intelligence OS for AI coding agents — one prompt in, Stripe-grade UI out.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages