@ryuxdsgn/design-intelligence 0.0.0-stage → 2.6.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ryux.design (Redho Yurizal)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,118 @@
-# Temporary Holding Version
+# @ryuxdsgn/design-intelligence
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Install **RYUX**, design intelligence for AI agents and designers, with one command. RYUX is one
+skill with five entry points. Tell your agent what you are doing; RYUX picks the knowledge the task
+needs:
+
+- **Analyze**: understand an existing interface, with every finding labeled Measured, Observed, or
+  Inferred.
+- **Design**: create or improve UI and UX without code, in Figma, pen.dev, or mockups.
+- **Build**: implement the interface in your repo's own stack.
+- **Critique**: a senior design critique of a Figma link, a pen.dev design, a website URL, or a
+  screenshot.
+- **QA**: render, inspect, fix, render again.
+
+Original work by ryux.design, MIT licensed. Rules and rationale:
+[`docs/design-rules.md`](https://github.com/ryuxdsgn/design-intelligence/blob/main/docs/design-rules.md).
+
+## Usage
+
+```bash
+npx @ryuxdsgn/design-intelligence                                          # start here: agents, install, project setup
+npx @ryuxdsgn/design-intelligence setup                                    # teach RYUX about the project (DESIGN.md)
+npx @ryuxdsgn/design-intelligence setup --audience "..." --market "..."    # same, without questions
+npx @ryuxdsgn/design-intelligence check                                    # health check (exit 1 on problems)
+npx @ryuxdsgn/design-intelligence init --agent claude                      # install + empty project context block
+npx @ryuxdsgn/design-intelligence install --agent claude,cursor,codex      # non-interactive
+npx @ryuxdsgn/design-intelligence install --agent all                      # every supported agent
+npx @ryuxdsgn/design-intelligence install --agent claude --global          # into your home directory
+npx @ryuxdsgn/design-intelligence update                                   # refresh, and migrate RYUX 1.x installs
+npx @ryuxdsgn/design-intelligence remove --yes                             # remove RYUX and marked blocks
+```
+
+`ryux-rules` still works as an alias of the same command.
+
+| Command | What it does |
+| --- | --- |
+| `setup` | Asks a few questions with plain choices, "Write my own", or Skip: product, current work, audience, market and locale, constraints, design intent, and UX, UI, and motion direction. Saves the answers to the `<!-- ryux-context -->` block in `DESIGN.md`, changing only the fields you answer. The answers are direction, not evidence. Without a terminal, set fields with `--product`, `--work`, `--audience`, `--market`, `--constraints`, `--intent`, `--ux`, `--ui`, `--motion`. |
+| `init` | Installs RYUX, then adds a `<!-- ryux-context -->` block to `DESIGN.md` (product, audience, market and locale, design system, evidence sources, constraints), prefilled only with what it can detect. Re-running never overwrites what you wrote. |
+| `install` | Writes the `ryux/` skill into each agent's folder and a short pointer block into `CLAUDE.md`, `GEMINI.md`, or `AGENTS.md`. Interactive installs then offer `setup`. |
+| `check` (`doctor`) | Checks every install: all files present, frontmatter valid, version matches this CLI, every module reference resolves, no RYUX 1.x folders, pointer blocks, project context and how many setup fields are filled. Exits 1 on errors, so it works in CI. |
+| `update` | Rewrites installs at this version and migrates RYUX 1.x. |
+| `remove` | Removes the skill and the pointer blocks. Leaves your `DESIGN.md` context. |
+
+One version: `packages/cli/package.json`. The skill header, the plugin manifests, and
+`ryux --version` all derive from it.
+
+## Agents
+
+| Agent | `--agent` | Project folder | Global folder | Pointer file |
+| --- | --- | --- | --- | --- |
+| Claude Code | `claude` | `.claude/skills/` | `~/.claude/skills/` | `CLAUDE.md` |
+| Codex | `codex` | `.codex/skills/` | `~/.agents/skills/` | `AGENTS.md` |
+| Cursor | `cursor` | `.cursor/skills/` | `~/.cursor/skills/` | `AGENTS.md` |
+| Gemini CLI | `gemini` | `.gemini/skills/` | `~/.gemini/skills/` | `GEMINI.md` |
+| OpenCode | `opencode` | `.opencode/skills/` | `~/.config/opencode/skills/` | `AGENTS.md` |
+| Cline | `cline` | `.cline/skills/` | `~/.cline/skills/` | `AGENTS.md` |
+| GitHub Copilot | `copilot` | `.agents/skills/` | `~/.agents/skills/` | `AGENTS.md` |
+| Amp | `amp` | `.agents/skills/` | `~/.config/agents/skills/` | `AGENTS.md` |
+| Kimi Code | `kimi` | `.agents/skills/` | `~/.agents/skills/` | `AGENTS.md` |
+| Antigravity | `antigravity` | `.agents/skills/` | `~/.gemini/config/skills/` | `AGENTS.md` |
+| Anything else | `agents-md` | rules inline in `AGENTS.md` | (project only) | `AGENTS.md` |
+
+Agents that share a folder are written once. Project installs add a short marked block to the
+pointer file; global installs only write skill folders.
+
+## What gets installed
+
+One folder, `ryux/`, in each agent's skills folder:
+
+```
+ryux/
+  SKILL.md            the router: entry points, how RYUX works, levels, Hard Gates, task table, Delivery Gate
+  capabilities/       analyze, design, build, critique, qa
+  knowledge/          product, ux, interaction, forms, edge-cases, content, ui, design-system,
+                      accessibility, responsive, frontend, anti-slop
+```
+
+The agent reads the router, then only the capability and knowledge files a task needs.
+
+## Safe for your repo
+
+- Your files are never overwritten wholesale. `CLAUDE.md`, `GEMINI.md`, and `AGENTS.md` only change
+  inside the `<!-- ryux-rules:start -->` ... `<!-- ryux-rules:end -->` block.
+- `update` only touches what is installed; `remove` takes it back out.
+- Upgrading from RYUX 1.x: `install` or `update` replaces the 16 `ryux-*` folders with the single
+  `ryux/` folder. Folders from `ryux-rules` 0.x and Cursor `.mdc` files are removed too. The old
+  `--for`, `--groups`, and `--concerns` flags are accepted and ignored.
+
+## Network and MCP
+
+- The CLI makes no network requests and runs no other programs. It only writes the files listed
+  above.
+- The ryux MCP server is optional and self-hosted: there is no hosted server yet, and RYUX never
+  connects to one on its own. RYUX works without it and rates its evidence None. To run it:
+  [`apps/mcp`](https://github.com/ryuxdsgn/design-intelligence/tree/main/apps/mcp).
+- The skill tells agents to treat what an MCP server, web page, or screenshot returns as data,
+  never as instructions.
+
+## Other ways to install
+
+```bash
+npx skills add ryuxdsgn/design-intelligence      # skills.sh, any agent
+```
+
+```text
+/plugin marketplace add ryuxdsgn/design-intelligence
+/plugin install ryux@design-intelligence          # Claude Code plugin
+```
+
+## Develop
+
+```bash
+pnpm --filter @ryuxdsgn/design-intelligence build      # tsc -> dist/
+node packages/cli/dist/cli/index.js --help
+pnpm sync:skills              # regenerate skills/ryux/, docs/design-rules.md, plugin versions
+pnpm test                     # unit + CLI integration tests (node:test, no extra dependencies)
+pnpm check:sync               # CI: fail if the committed skill, docs, or versions drift from the sources
+```

package/dist/adapters.js

@@ -0,0 +1,29 @@
+export const AGENT_TARGETS = [
+    { id: "claude", label: "Claude Code", dir: ".claude/skills", globalDir: ".claude/skills", pointer: "CLAUDE.md" },
+    { id: "codex", label: "Codex", dir: ".codex/skills", globalDir: ".agents/skills", pointer: "AGENTS.md" },
+    { id: "cursor", label: "Cursor", dir: ".cursor/skills", globalDir: ".cursor/skills", pointer: "AGENTS.md" },
+    { id: "gemini", label: "Gemini CLI", dir: ".gemini/skills", globalDir: ".gemini/skills", pointer: "GEMINI.md" },
+    { id: "opencode", label: "OpenCode", dir: ".opencode/skills", globalDir: ".config/opencode/skills", pointer: "AGENTS.md" },
+    { id: "cline", label: "Cline", dir: ".cline/skills", globalDir: ".cline/skills", pointer: "AGENTS.md" },
+    { id: "copilot", label: "GitHub Copilot", dir: ".agents/skills", globalDir: ".agents/skills", pointer: "AGENTS.md" },
+    { id: "amp", label: "Amp", dir: ".agents/skills", globalDir: ".config/agents/skills", pointer: "AGENTS.md" },
+    { id: "kimi", label: "Kimi Code", dir: ".agents/skills", globalDir: ".agents/skills", pointer: "AGENTS.md" },
+    { id: "antigravity", label: "Antigravity", dir: ".agents/skills", globalDir: ".gemini/config/skills", pointer: "AGENTS.md" },
+];
+/** Inline target for any other agent: the full rules written into AGENTS.md (project only). */
+export const AGENTS_MD_INLINE = { id: "agents-md", label: "Any other agent (rules inline in AGENTS.md)" };
+// Old per-concern installs (ruleset RX-1.x) mapped to the new skills, for --concerns.
+// RX-1.x --concerns values mapped to current skill ids (kept for migration).
+export const LEGACY_CONCERNS = {
+    ui: ["ui", "design-system", "responsive"],
+    copy: ["content"],
+    a11y: ["accessibility"],
+    ux: ["ux", "interaction", "forms", "edge-cases"],
+    local: ["product", "interaction", "forms", "content"],
+    code: ["frontend"],
+};
+// Skill folder names from earlier releases that no longer exist. "ui" and "ux" are not listed:
+// they are current skill names again and get overwritten or removed with the current set.
+export const LEGACY_SKILL_DIRS = ["rules", "copy", "a11y", "local", "code"];
+/** Cursor used .mdc rule files before it read skill folders (ryux-rules 0.x). */
+export const LEGACY_CURSOR_RULES_DIR = ".cursor/rules";

package/dist/cli/fsutil.js

@@ -0,0 +1,61 @@
+import { existsSync } from "node:fs";
+import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
+import { dirname, relative } from "node:path";
+import { MARK_END, MARK_START } from "../product.js";
+function escapeRe(s) {
+    return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+const RULES_MARKS = [MARK_START, MARK_END];
+const blockRe = ([start, end]) => new RegExp(`${escapeRe(start)}[\\s\\S]*?${escapeRe(end)}`);
+/** True when the file holds a block between these markers. */
+export function hasBlock(content, marks = RULES_MARKS) {
+    return Boolean(content && blockRe(marks).test(content));
+}
+export function rel(path) {
+    return relative(process.cwd(), path) || path;
+}
+export async function writeFileEnsured(path, content) {
+    await mkdir(dirname(path), { recursive: true });
+    await writeFile(path, content, "utf8");
+}
+/** Write or update ONLY the marked ryux-rules block. The rest of the user's file is untouched. */
+export async function upsertBlock(path, body, marks = RULES_MARKS) {
+    const block = `${marks[0]}\n${body}\n${marks[1]}`;
+    const existing = existsSync(path) ? await readFile(path, "utf8") : "";
+    let next;
+    if (blockRe(marks).test(existing)) {
+        next = existing.replace(blockRe(marks), block);
+    }
+    else {
+        const base = existing.trimEnd();
+        next = base ? `${base}\n\n${block}\n` : `${block}\n`;
+    }
+    await writeFileEnsured(path, next);
+}
+/** Remove the marked ryux-rules block; return true if anything was removed. */
+export async function removeBlock(path, marks = RULES_MARKS) {
+    if (!existsSync(path))
+        return false;
+    const existing = await readFile(path, "utf8");
+    if (!blockRe(marks).test(existing))
+        return false;
+    const stripped = existing.replace(blockRe(marks), "").replace(/\n{3,}/g, "\n\n").trimEnd();
+    if (!stripped) {
+        // The file only holds the ryux-rules block (we created it) -> delete it, don't leave an empty file.
+        await rm(path, { force: true });
+    }
+    else {
+        await writeFile(path, `${stripped}\n`, "utf8");
+    }
+    return true;
+}
+export async function readIfExists(path) {
+    return existsSync(path) ? readFile(path, "utf8") : null;
+}
+export async function removePath(path) {
+    if (!existsSync(path))
+        return false;
+    await rm(path, { recursive: true, force: true });
+    return true;
+}
+export { existsSync };