Skip to content
Back to search

auis-ux-flow

MarketplaceWorks with Claude CodeGitHub

Compiled UX flows: several journeys on one board, shared screens drawn once, one lens per scenario.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/gregoriombp--auis-ux-flow/badge.svg)](/listings/gregoriombp--auis-ux-flow)

HTML

<a href="/listings/gregoriombp--auis-ux-flow"><img src="/api/listings/gregoriombp--auis-ux-flow/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

With the [skills CLI](https://github.com/vercel-labs/skills) (Claude Code, Codex, Cursor and others):

npx skills add gregoriombp/auis-ux-flow

As a Claude Code plugin:

/plugin marketplace add gregoriombp/auis-ux-flow
/plugin install auis-ux-flow@auis-ux-flow

Or copy [`skills/auis-ux-flow`](skills/auis-ux-flow) into your project's `.claude/skills/` (Claude Code) or `.agents/skills/` (Codex, Cursor).

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 12 lines
  1. {
  2. "name": "auis-ux-flow",
  3. "description": "Compiled UX flows: several journeys on one board, shared screens drawn once, one lens per scenario.",
  4. "owner": { "name": "Gregorio Pinheiro" },
  5. "plugins": [
  6. {
  7. "name": "auis-ux-flow",
  8. "source": "./",
  9. "description": "Map several user journeys of a product on one board, in any repository. Writes data files; a single-file viewer renders them."
  10. }
  11. ]
  12. }
README.md · README · 118 lines
  1. # Auis UX Flow
  2. An agent skill that maps **several user journeys of your product on one board**. Screens the journeys share are drawn once, with one dot per journey, and a lens per journey dims everything else.
  3. A normal flow diagram shows one path. This shows where paths meet, where they split, and which screens carry more than one of them.
  4. ![Three journeys on one board; the lens isolates each one in turn](docs/preview.gif)
  5. **[Open the live demo](https://gregoriombp.github.io/auis-ux-flow/)** (three example flows) · [watch it cycle the lenses](https://gregoriombp.github.io/auis-ux-flow/#/workspace?tour=1)
  6. ![The demo's index: three flows, each drawn as a thumbnail of its own board](docs/flows.png)
  7. Works in any repository and any stack. Nothing is installed in your project: the agent writes data files, and a single HTML file renders them. Open it with a double-click.
  8. ## Install
  9. With the [skills CLI](https://github.com/vercel-labs/skills) (Claude Code, Codex, Cursor and others):
  10. ```bash
  11. npx skills add gregoriombp/auis-ux-flow
  12. ```
  13. As a Claude Code plugin:
  14. ```text
  15. /plugin marketplace add gregoriombp/auis-ux-flow
  16. /plugin install auis-ux-flow@auis-ux-flow
  17. ```
  18. Or copy [`skills/auis-ux-flow`](skills/auis-ux-flow) into your project's `.claude/skills/` (Claude Code) or `.agents/skills/` (Codex, Cursor).
  19. ## Use
  20. Ask your agent, in your own repository:
  21. ```text
  22. Map sign-up, invite and checkout as a UX flow.
  23. ```
  24. ```text
  25. Compile "create a workspace" and "adjust an existing workspace" into one flow.
  26. ```
  27. The agent reads your routes and screens, works out which screens the journeys share, and writes:
  28. ```
  29. ux-flows/
  30. index.html the viewer (one file, no dependencies)
  31. flows.js which flows to show
  32. <slug>.flow.js the flow: scenarios, cards, edges, changelog
  33. ```
  34. Open `ux-flows/index.html`. Commit the folder; publish it anywhere static if you want to share the map.
  35. ## What you get
  36. - **Shared screens, drawn once.** A card with two or more dots is one screen used by several journeys.
  37. - **A lens per journey.** Pick one: everything outside it dims, and a band frames its path.
  38. - **Real screens one click away.** A card opens the running screen in a side panel, with one tab per state (empty, loading, error) when those states have URLs.
  39. - **Gates and convergences made explicit.** Decisions are their own cards; the places where journeys rejoin are the cards with the most dots.
  40. - **Notes that go back to the agent.** Leave notes on cards in Comment mode, drag cards where you want them, then **Copy for agent** and paste: the agent updates the flow and its changelog.
  41. - **A changelog** of structural changes, kept in the flow file.
  42. - Dark by default, with a light theme; fullscreen; deep links: `index.html#/checkout?focus=guest`.
  43. ## Keeping a flow up to date
  44. ```text
  45. Add the gift-card journey to the checkout flow.
  46. ```
  47. ```text
  48. <paste the block from "Copy for agent">
  49. ```
  50. The skill classifies the change, edits the flow file, adds a changelog entry and runs the validator.
  51. ## How it works
  52. | Piece | What it does |
  53. |---|---|
  54. | [`SKILL.md`](skills/auis-ux-flow/SKILL.md) | The method: read the product, do the merge analysis, lay out lanes, write the flow, validate. |
  55. | [`assets/viewer.html`](skills/auis-ux-flow/assets/viewer.html) | The viewer, built into one file. It loads flows through script tags, so it runs from disk (`file://`) without a server. |
  56. | [`scripts/validate.mjs`](skills/auis-ux-flow/scripts/validate.mjs) | Checks a `ux-flows/` folder with no dependencies: broken references, a card cut off from its lens, an edge no lens can light, overlapping cards. The viewer runs the same rules and shows what it finds. |
  57. | [`references/`](skills/auis-ux-flow/references) | The [flow file format](skills/auis-ux-flow/references/flow-format.md) and the [layout guide](skills/auis-ux-flow/references/layout.md). |
  58. Run the validator yourself:
  59. ```bash
  60. node path/to/skills/auis-ux-flow/scripts/validate.mjs ux-flows
  61. ```
  62. ## Limits
  63. - Card positions are chosen by the agent and adjustable by drag. There is no auto-layout.
  64. - Screen previews need your app running at the flow's `baseUrl`, and an app that allows being embedded. When it does not, the panel's "Open in a new tab" still works.
  65. - Screens behind a login open signed out in the panel when the viewer is opened from disk: browsers do not send an app's session to a page embedded from elsewhere. Serve `ux-flows/` from the app itself (its public or static folder) to preview them signed in.
  66. - Notes and dragged positions live in your browser until you copy them to the agent.
  67. - The validator needs Node 18 or newer. The viewer needs only a current browser.
  68. ## Part of Auis
  69. This skill is one piece of [Auis](https://github.com/gregoriombp/AuisDesign), a toolkit for designing product UI with coding agents: design-system skills, in-page review comments, live edits, and a State Mode that gives every screen state a URL. If the flow is useful, the rest is built the same way.
  70. ## Development
  71. ```bash
  72. cd viewer
  73. npm install
  74. npm run dev # the viewer with the demo flow from docs/
  75. npm run build # rebuilds skills/auis-ux-flow/assets/viewer.html and docs/index.html
  76. node --test ../tests/*.test.mjs
  77. ```
  78. `docs/` is the live demo: the built viewer, three example flows (`workspace`, `join`, `billing`) and their mock screens.
  79. ## License
  80. MIT

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.