Skip to content
Back to search

openflowkit

MarketplaceWorks with Claude CodeGitHub

OpenFlowKit: diagrams for coding agents

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/openflowkit--openflowkit/badge.svg)](/listings/openflowkit--openflowkit)

HTML

<a href="/listings/openflowkit--openflowkit"><img src="/api/listings/openflowkit--openflowkit/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.

**In the browser:** [app.openflowkit.com](https://app.openflowkit.com). Nothing to install, no account.

**In a terminal:** `npx openflowkit` (Node 20.11+).

**Run it locally** (Node 22.22+):

git clone https://github.com/openflowkit/openflowkit.git
cd openflowkit
npm install && npm run dev      # http://localhost:3000

Connect your agent

OpenFlowKit has one set of agent tools. Pick the row for where your agent runs:

| Your agent runs… | How to connect | What it can do | | --- | --- | --- | | **On your computer**: Claude Code, Cursor, VS Code, Claude Desktop, Windsurf | The MCP server, below | Everything: draws on your open canvas (one undo step per change), edits `.openflow.json` files in your repo, maps a codebase, takes screenshots | | **In a chat app**: claude.ai, Claude Desktop, ChatGPT | Add a custom connector: `https://mcp.openflowkit.com/mcp`, choose **No sign-in** | Draws a diagram in the chat as a card, with **Open in OpenFlowKit**. Not on your open canvas | | **In your browser** (experimental) | Nothing to install: open a diagram in a browser whose agent supports [WebMCP](https://docs.openflowkit.com/webmcp/) | Reads and edits the diagram you have open |

For Claude Code, one line:

claude mcp add -s user openflowkit -- npx -y openflowkit mcp

For Codex: `codex mcp add openflowkit -- npx -y openflowkit mcp`.

For Claude Desktop, Windsurf and any other MCP client:

{
  "mcpServers": {
    "openflowkit": { "command": "npx", "args": ["-y", "openflowkit", "mcp"] }
  }
}

Restart the agent, then click **Connect agent** in the app, or open [app.openflowkit.com/#/connect](https://app.openflowkit.com/#/connect). That panel has the steps for each client and copies the same config with a pairing token. With no app open, the same tools edit `.openflow.json` files in your repo. Every client, step by step, with fixes: [Connect your agent](https://docs.openflowkit.com/connect-your-agent/).

<details> <summary><b>Plugins: Claude Code and Codex</b> (server and skill in one install)</summary>

# Claude Code
claude plugin marketplace add openflowkit/openflowkit
claude plugin install openflowkit@openflowkit

# Codex: add the marketplace, then install OpenFlowKit from the Plugins Directory
codex plugin marketplace add openflowkit/openflowkit

The skill ([`skills/openflowkit/SKILL.md`](skills/openflowkit/SKILL.md)) tells an agent when a diagram helps, how to write it, and to save it beside the code. Agents that read the web get the same text at `https://app.openflowkit.com/llms.txt`. </details>

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 · 15 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. {
  2. "name": "openflowkit",
  3. "description": "OpenFlowKit: diagrams for coding agents",
  4. "owner": {
  5. "name": "OpenFlowKit",
  6. "url": "https://github.com/openflowkit/openflowkit"
  7. },
  8. "plugins": [
  9. {
  10. "name": "openflowkit",
  11. "source": "./plugin",
  12. "description": "The OpenFlowKit MCP server and diagram skill."
  13. }
  14. ]
  15. }
README.md · README · 425 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <p align="center">
  2. <a href="https://app.openflowkit.com"><img src="public/Logo_openflowkit.svg" width="72" height="72" alt="OpenFlowKit logo"></a>
  3. </p>
  4. <h1 align="center">OpenFlowKit</h1>
  5. <p align="center">
  6. <b>Architecture diagrams you draw, write as code, or hand to your agent.</b><br>
  7. Free, open source and local-first. Paste a GitHub repo and get its map, every arrow cited to a line of code.
  8. </p>
  9. <p align="center">
  10. <a href="https://app.openflowkit.com"><b>Open the app</b></a> &nbsp;·&nbsp;
  11. <a href="https://docs.openflowkit.com/">Docs</a> &nbsp;·&nbsp;
  12. <a href="#connect-your-agent">MCP setup</a> &nbsp;·&nbsp;
  13. <a href="https://github.com/openflowkit/openflowkit/discussions">Discussions</a> &nbsp;·&nbsp;
  14. <a href="https://github.com/openflowkit/openflowkit/issues">Issues</a>
  15. </p>
  16. <p align="center">
  17. <a href="https://github.com/openflowkit/openflowkit/actions/workflows/quality.yml"><img src="https://github.com/openflowkit/openflowkit/actions/workflows/quality.yml/badge.svg" alt="CI status"></a>
  18. <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT license"></a>
  19. <a href="https://www.npmjs.com/package/@openflowkit/openflowkit-mcp"><img src="https://img.shields.io/npm/v/@openflowkit/openflowkit-mcp?label=mcp%20server" alt="MCP server version on npm"></a>
  20. <a href="https://www.npmjs.com/package/openflowkit"><img src="https://img.shields.io/npm/v/openflowkit?label=cli" alt="CLI version on npm"></a>
  21. </p>
  22. <p align="center">
  23. <a href="https://www.producthunt.com/products/openflowkit"><picture>
  24. <source media="(prefers-color-scheme: dark)" srcset="https://api.producthunt.com/widgets/embed-image/v1/top-post-topic-badge.svg?post_id=1081019&theme=dark&period=weekly&topic_id=44">
  25. <img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-topic-badge.svg?post_id=1081019&theme=light&period=weekly&topic_id=44" width="200" height="43" alt="OpenFlowKit: #4 Product of the Week in Design Tools on Product Hunt">
  26. </picture></a>
  27. </p>
  28. <p align="center">
  29. <a href="https://app.openflowkit.com"><picture>
  30. <source media="(prefers-color-scheme: dark)" srcset="assets/readme/hero-dark.gif">
  31. <source media="(prefers-color-scheme: light)" srcset="assets/readme/hero-light.gif">
  32. <img src="assets/readme/hero-light.gif" width="900" alt="An agent draws an architecture diagram on the OpenFlowKit canvas, live; the user drags a box, edits one line of text and regenerates">
  33. </picture></a>
  34. </p>
  35. ## Why OpenFlowKit
  36. ### 1. Your agent draws on your canvas, live
  37. Connect Claude Code, Cursor or any MCP client and ask for a diagram. The agent reads the page,
  38. draws, restyles and takes a screenshot to check its own work while you watch. Every change it
  39. makes is one undo step, like your own. [Connect your agent ↓](#connect-your-agent)
  40. ### 2. Text and canvas are the same diagram
  41. ```
  42. flowchart right
  43. Client [blue] -> "API Gateway" [emerald] : HTTPS
  44. "API Gateway" -> Queue [queue, amber]
  45. Queue -> Worker
  46. Worker -> Store [cylinder, red, bold]
  47. ```
  48. Open the code panel (<kbd>⌥C</kbd>), paste this into it and press <kbd>⌘↵</kbd>. Drag things
  49. around on the canvas or edit the text; <kbd>⌘↵</kbd> regenerates the frame from the text as
  50. one undo step. Paste Mermaid, Structurizr or D2 and it converts.
  51. <p align="center">
  52. <picture>
  53. <source media="(prefers-color-scheme: dark)" srcset="assets/readme/code-dark.png">
  54. <source media="(prefers-color-scheme: light)" srcset="assets/readme/code-light.png">
  55. <img src="assets/readme/code-light.png" width="800" alt="The code panel beside the canvas: the same diagram as text and as shapes">
  56. </picture>
  57. </p>
  58. ### 3. Paste a GitHub repo, get its map
  59. Type `owner/repo` into the box on an empty canvas and press **Map repo**, or open
  60. `app.openflowkit.com/#/map/github/<owner>/<repo>`
  61. ([try a sample](https://app.openflowkit.com/#/map/github/dockersamples/example-voting-app)).
  62. Your browser reads the repo from GitHub and draws its parts. Boxes open in place, and every
  63. arrow lists the `file:line` behind it, linked to the code. No key and no install. For a private
  64. repo, add a read-only GitHub token on the page, or map a checkout: `npx openflowkit map . --html map.html`
  65. ([private repos](https://docs.openflowkit.com/map-mode/#private-repos)).
  66. <p align="center">
  67. <picture>
  68. <source media="(prefers-color-scheme: dark)" srcset="assets/readme/map-dark.gif">
  69. <source media="(prefers-color-scheme: light)" srcset="assets/readme/map-light.gif">
  70. <img src="assets/readme/map-light.gif" width="900" alt="The map of GoogleCloudPlatform/microservices-demo: a click on checkoutservice opens it in place, showing the files inside, while the side panel lists what it talks to">
  71. </picture>
  72. </p>
  73. ### 4. Export it, including the animation
  74. PNG, SVG, PDF, JSON, or **Copy as Mermaid** for a README. Add an `animate` block to the text
  75. above to name the steps, and the export renders animated SVG, GIF, MP4 or WebM in your browser.
  76. ```
  77. animate build 6s loop {
  78. step Client
  79. step Client -> "API Gateway" : HTTPS
  80. step Queue, Worker
  81. step Store hold 2s
  82. }
  83. ```
  84. <p align="center">
  85. <picture>
  86. <source media="(prefers-color-scheme: dark)" srcset="assets/motion/flow-build-dark.svg">
  87. <source media="(prefers-color-scheme: light)" srcset="assets/motion/flow-build-light.svg">
  88. <img src="assets/motion/flow-build-light.svg" width="900" alt="The diagram above building step by step, exported as an animated SVG">
  89. </picture>
  90. </p>
  91. <sub>That animation is the two snippets above, exported by the app as an animated SVG. GitHub plays it like an image.</sub>
  92. ## Ten diagram types, one language
  93. Every type is the same short, forgiving text, with per-line errors that say how to fix them.
  94. Each picture below is the first example on its docs page, rendered by the `openflowkit` CLI.
  95. <table>
  96. <tr>
  97. <td width="50%"><a href="https://docs.openflowkit.com/diagram-architecture/"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/types/architecture-dark.png"><img src="assets/readme/types/architecture-light.png" alt="Architecture diagram with Node.js and AWS Lambda icons"></picture></a><br><b>Architecture</b> · cloud icons, groups, a C4 model with views</td>
  98. <td width="50%"><a href="https://docs.openflowkit.com/diagram-sequence/"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/types/sequence-dark.png"><img src="assets/readme/types/sequence-light.png" alt="Sequence diagram of a login"></picture></a><br><b>Sequence</b> · alt / opt / loop, notes, activations</td>
  99. </tr>
  100. <tr>
  101. <td><a href="https://docs.openflowkit.com/diagram-flowchart/"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/types/flowchart-dark.png"><img src="assets/readme/types/flowchart-light.png" alt="Flowchart"></picture></a><br><b>Flowchart</b> · shapes, decisions, groups</td>
  102. <td><a href="https://docs.openflowkit.com/diagram-erd/"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/types/erd-dark.png"><img src="assets/readme/types/erd-light.png" alt="Entity-relationship diagram"></picture></a><br><b>ERD</b> · columns, keys, crow's-foot cardinality</td>
  103. </tr>
  104. <tr>
  105. <td><a href="https://docs.openflowkit.com/diagram-state/"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/types/state-dark.png"><img src="assets/readme/types/state-light.png" alt="State machine"></picture></a><br><b>State</b> · start and end, composite states</td>
  106. <td><a href="https://docs.openflowkit.com/diagram-class/"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/types/class-dark.png"><img src="assets/readme/types/class-light.png" alt="Class diagram"></picture></a><br><b>Class</b> · members, stereotypes, relations</td>
  107. </tr>
  108. <tr>
  109. <td><a href="https://docs.openflowkit.com/diagram-mindmap/"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/types/mindmap-dark.png"><img src="assets/readme/types/mindmap-light.png" alt="Mind map"></picture></a><br><b>Mind map</b> · indentation is the tree</td>
  110. <td><a href="https://docs.openflowkit.com/diagram-gitgraph/"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/types/gitgraph-dark.png"><img src="assets/readme/types/gitgraph-light.png" alt="Git graph"></picture></a><br><b>Git graph</b> · branches, merges, tags</td>
  111. </tr>
  112. <tr>
  113. <td><a href="https://docs.openflowkit.com/diagram-chart/"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/types/chart-dark.png"><img src="assets/readme/types/chart-light.png" alt="Bar chart"></picture></a><br><b>Chart</b> · data written as text, editable in a table</td>
  114. <td><a href="https://docs.openflowkit.com/diagram-wireframe/"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/types/wireframe-dark.png"><img src="assets/readme/types/wireframe-light.png" alt="Phone wireframe"></picture></a><br><b>Wireframe</b> · 35 controls on phone, tablet or desktop screens</td>
  115. </tr>
  116. </table>
  117. The language is versioned and written down in one file: **[src/dsl/grammar.md](src/dsl/grammar.md)**
  118. ([docs](https://docs.openflowkit.com/openflow-dsl/)). The same text powers the code panel, the
  119. assistant, the MCP tools and the CLI.
  120. ## Quick start
  121. **In the browser:** [app.openflowkit.com](https://app.openflowkit.com). Nothing to install, no account.
  122. **In a terminal:** `npx openflowkit` (Node 20.11+).
  123. **Run it locally** (Node 22.22+):
  124. ```bash
  125. git clone https://github.com/openflowkit/openflowkit.git
  126. cd openflowkit
  127. npm install && npm run dev # http://localhost:3000
  128. ```
  129. ### Connect your agent
  130. OpenFlowKit has one set of agent tools. Pick the row for where your agent runs:
  131. | Your agent runs… | How to connect | What it can do |
  132. | --- | --- | --- |
  133. | **On your computer**: Claude Code, Cursor, VS Code, Claude Desktop, Windsurf | The MCP server, below | Everything: draws on your open canvas (one undo step per change), edits `.openflow.json` files in your repo, maps a codebase, takes screenshots |
  134. | **In a chat app**: claude.ai, Claude Desktop, ChatGPT | Add a custom connector: `https://mcp.openflowkit.com/mcp`, choose **No sign-in** | Draws a diagram in the chat as a card, with **Open in OpenFlowKit**. Not on your open canvas |
  135. | **In your browser** (experimental) | Nothing to install: open a diagram in a browser whose agent supports [WebMCP](https://docs.openflowkit.com/webmcp/) | Reads and edits the diagram you have open |
  136. <a href="https://cursor.com/en/install-mcp?name=openflowkit&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIm9wZW5mbG93a2l0IiwibWNwIl19"><img src="https://cursor.com/deeplink/mcp-install-dark.svg" height="32" alt="Add OpenFlowKit to Cursor"></a>
  137. <a href="https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522openflowkit%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522openflowkit%2522%252C%2522mcp%2522%255D%257D"><img src="https://img.shields.io/badge/VS_Code-Install_OpenFlowKit-0098FF?logo=visualstudiocode&logoColor=white" height="32" alt="Install OpenFlowKit in VS Code"></a>
  138. For Claude Code, one line:
  139. ```bash
  140. claude mcp add -s user openflowkit -- npx -y openflowkit mcp
  141. ```
  142. For Codex: `codex mcp add openflowkit -- npx -y openflowkit mcp`.
  143. For Claude Desktop, Windsurf and any other MCP client:
  144. ```json
  145. {
  146. "mcpServers": {
  147. "openflowkit": { "command": "npx", "args": ["-y", "openflowkit", "mcp"] }
  148. }
  149. }
  150. ```
  151. Restart the agent, then click **Connect agent** in the app, or open
  152. [app.openflowkit.com/#/connect](https://app.openflowkit.com/#/connect). That panel has the steps for each client
  153. and copies the same config with a pairing token. With no app open, the same tools edit `.openflow.json` files in
  154. your repo. Every client, step by step, with fixes: [Connect your agent](https://docs.openflowkit.com/connect-your-agent/).
  155. <details>
  156. <summary><b>Plugins: Claude Code and Codex</b> (server and skill in one install)</summary>
  157. ```bash
  158. # Claude Code
  159. claude plugin marketplace add openflowkit/openflowkit
  160. claude plugin install openflowkit@openflowkit
  161. # Codex: add the marketplace, then install OpenFlowKit from the Plugins Directory
  162. codex plugin marketplace add openflowkit/openflowkit
  163. ```
  164. The skill ([`skills/openflowkit/SKILL.md`](skills/openflowkit/SKILL.md)) tells an agent when a
  165. diagram helps, how to write it, and to save it beside the code. Agents that read the web get the
  166. same text at `https://app.openflowkit.com/llms.txt`.
  167. </details>
  168. ## Working with agents
  169. The MCP server gives your agent the operations you have, on the live canvas or on files.
  170. | It can | With |
  171. |---|---|
  172. | **Draw** a diagram from text or Mermaid, then change it | `create_diagram`, `update_diagram`, `add_shape` |
  173. | **Read** every page, the text behind a diagram, and what you selected | `get_document`, `get_diagram`, `list_pages` |
  174. | **Restyle and move** what is already there | `style`, `move`, `delete` |
  175. | **See** its own result | `screenshot` returns a real image the model can look at |
  176. | **Hand you files** | `export`: SVG, PNG, PDF, JSON or an animated SVG |
  177. | **Read your repo** | `discover_architecture`, `drift_report`, `explain_element` |
  178. Things to ask for:
  179. - *"Draw the architecture of this repository."*
  180. - *"Make the boxes I selected red and add a cache in front of the API."*
  181. - *"Turn the Mermaid in our README into a diagram I can edit."*
  182. - *"Compare architecture.ofk with the code and tell me what drifted."*
  183. Your canvas edits are safe: if you moved, restyled or renamed something and the agent regenerates
  184. from text, `get_diagram` hands it the text that keeps each edit, and `update_diagram` reports
  185. anything it had to drop. Every agent change is one undo step, and the Connect panel shows the
  186. last one with an **Undo** button.
  187. <details>
  188. <summary><b>All 29 tools</b></summary>
  189. Sixteen editor operations, which also work on files: `create_diagram`, `update_diagram`,
  190. `get_diagram`, `list_diagrams`, `get_syntax`, `search_icons`, `find_icons_for`, `move`, `style`,
  191. `delete`, `add_shape`, `export`, `screenshot`, `fit_view`, `get_document`, `list_pages`.
  192. Thirteen for files and repositories: `openflow_create`, `openflow_open`, `openflow_save`, `whoami`,
  193. `server_info`, `validate_openflow_dsl`, `list_diagram_node_types`, `list_starter_templates`,
  194. `get_starter_template`, `analyze_codebase`, `discover_architecture`, `drift_report`,
  195. `explain_element`.
  196. Arguments and examples: [MCP server docs](https://docs.openflowkit.com/mcp-server/). The op
  197. manifest is [`src/agent/manifest.ts`](src/agent/manifest.ts). Requires Node 20.11+.
  198. </details>
  199. **Bring your own key instead:** <kbd>⌘J</kbd> opens the assistant. Pick Claude, OpenAI, Gemini,
  200. Groq, Mistral, Cerebras, NVIDIA, OpenRouter, Ollama or any OpenAI-compatible endpoint (LM Studio…)
  201. and paste a key. The key stays in this browser, and the reply arrives as a proposal you apply or
  202. dismiss.
  203. ## Bring the diagrams you already have
  204. Paste into the code panel and it converts, with an honest list of anything it couldn't carry.
  205. Mermaid pasted straight onto the canvas draws in place.
  206. | From | What converts |
  207. |---|---|
  208. | **Mermaid** | flowchart / graph, sequenceDiagram, stateDiagram, erDiagram, classDiagram, mindmap, architecture, gitGraph |
  209. | **Structurizr DSL** | the model, views and styles, as a C4 workspace with one page per view |
  210. | **D2** | shapes, connections and containers |
  211. Going back out, **Copy as Mermaid** writes a flowchart or sequence diagram as Mermaid text for a
  212. README or wiki. [Mermaid](https://docs.openflowkit.com/mermaid-import/) ·
  213. [coming from Structurizr](https://docs.openflowkit.com/coming-from-structurizr/)
  214. ## In your repo and CI
  215. The `openflowkit` CLI runs the same engine as the app, from any terminal or CI job:
  216. ```bash
  217. npx openflowkit render diagram.ofk -o diagram.svg # Mermaid, D2, Structurizr or DSL → SVG
  218. npx openflowkit validate diagram.ofk --strict # exit 1 on an error
  219. npx openflowkit convert flow.mmd -o flow.openflow.json
  220. npx openflowkit discover . --out architecture.ofk # draft a C4 model of this repo
  221. npx openflowkit drift . # exit 1 when the code moved on
  222. ```
  223. <p align="center">
  224. <img src="assets/readme/cli-welcome.png" width="720" alt="Running npx openflowkit: a welcome box, OPEN FLOWKIT in orange block letters, and three commands to try">
  225. </p>
  226. Commit `architecture.ofk` next to the code and `drift` keeps it honest in CI. The **PR diagrams
  227. Action** comments on a pull request with how its diagrams changed: node and connector counts, the
  228. text diff, and drift for `.ofk` models.
  229. [CLI](https://docs.openflowkit.com/cli/) · [GitHub Action](https://docs.openflowkit.com/github-action/)
  230. ## Exports and sharing
  231. | Format | Notes |
  232. |---|---|
  233. | PNG | 1× or 2×; light, dark or print theme; transparent background optional |
  234. | SVG, PDF | vector, with icons and the Inter font embedded |
  235. | JSON | the whole document, every page; opens in any browser |
  236. | Animated SVG, GIF, MP4, WebM | made in your browser from the `animate` block or the connector order |
  237. | Copy as Mermaid | flowchart and sequence |
  238. | Share links | a view-only link, encrypted in your browser; or an editable copy, the code inside the link, nothing uploaded |
  239. ## Keyboard
  240. Every action has a key, and <kbd>?</kbd> lists them all in the app.
  241. <details>
  242. <summary><b>The ones you'll use first</b></summary>
  243. | Key | Action |
  244. |---|---|
  245. | <kbd>V</kbd> <kbd>R</kbd> <kbd>O</kbd> <kbd>T</kbd> <kbd>A</kbd> | select, rectangle, ellipse, text, connector |
  246. | <kbd>⌥C</kbd> · <kbd>⌘↵</kbd> | code panel · generate from text |
  247. | <kbd>⌘J</kbd> | AI assistant |
  248. | <kbd>M</kbd> | switch Canvas and Map |
  249. | <kbd>⌘F</kbd> | find on the canvas |
  250. | <kbd>⇧1</kbd> · <kbd>⇧2</kbd> | fit everything · zoom to selection |
  251. | <kbd>⌘G</kbd> · <kbd>⌘D</kbd> | group · duplicate |
  252. | <kbd>Enter</kbd> | edit the selected shape's label |
  253. On Windows and Linux, <kbd>Ctrl</kbd> and <kbd>Alt</kbd> replace <kbd>⌘</kbd> and <kbd>⌥</kbd>.
  254. </details>
  255. ## How it works
  256. <p align="center">
  257. <picture>
  258. <source media="(prefers-color-scheme: dark)" srcset="assets/readme/how-it-works-dark.svg">
  259. <source media="(prefers-color-scheme: light)" srcset="assets/readme/how-it-works-light.svg">
  260. <img src="assets/readme/how-it-works-light.svg" width="900" alt="You, your agent and imported Mermaid, Structurizr or D2 all become OpenFlow DSL; the compiler turns it into one undo step on the scene document, which feeds the canvas, the exports and browser storage">
  261. </picture>
  262. </p>
  263. <sub>This diagram is OpenFlowKit text too: <a href="assets/readme/how-it-works.ofk">how-it-works.ofk</a>, exported as an animated SVG with the pulse preset.</sub>
  264. You and your agent can also draw straight on the canvas; every edit, from text or by hand, is a
  265. command on the same document.
  266. Any frame on the canvas writes back out as canonical text, and `format(format(x)) == format(x)`
  267. holds in the tests. The language and document code is plain TypeScript with no React, Pixi or
  268. DOM, which is why the same compiler runs in the browser, the MCP server and the CLI. The full
  269. tour: **[ARCHITECTURE.md](ARCHITECTURE.md)**.
  270. <details>
  271. <summary><b>Repository layout</b></summary>
  272. | Path | What |
  273. |---|---|
  274. | `src/dsl/` | the language: grammar, parser, diagram families, compile and serialize, repo discovery |
  275. | `src/opencanvas/` | the editor: document model and commands, Pixi renderer, exporters, React UI |
  276. | `src/agent/` | the operations agents call, the bridge protocol, the op manifest |
  277. | `mcp-server/` | the published MCP server and `openflowkit` CLI |
  278. | `cli/` | `openflowkit` on npm: the short name for the CLI |
  279. | `plugin/`, `skills/` | the Claude Code and Codex plugins, and the agent skill |
  280. | `action/` | the PR diagrams GitHub Action |
  281. | `worker/` | the share-link Worker (stores ciphertext only) |
  282. | `stats/` | the private usage dashboard Worker |
  283. | `docs-site/` | the docs site |
  284. </details>
  285. ## Self-host
  286. ```bash
  287. docker build -t openflowkit . && docker run --rm -p 3045:3045 openflowkit # http://localhost:3045
  288. ```
  289. The image is the static build behind nginx, with the same headers as the hosted app. Content
  290. security policy, AI providers on your own network, and share links:
  291. [self-hosting](https://docs.openflowkit.com/self-hosting/).
  292. ## Privacy
  293. Your diagrams stay in your browser. Something leaves it only when you choose: AI with your own key
  294. goes to that provider, a share link uploads an encrypted copy, a repo map reads from GitHub.
  295. No account needed. We collect basic usage stats to improve OpenFlowKit; turn them off in Settings.
  296. Back up everything at once with **Download all diagrams** on Home; **Import** restores it in any browser.
  297. <details>
  298. <summary><b>FAQ</b></summary>
  299. **Is it free?** Yes: MIT licensed, free to use and to self-host. A Pro plan for teams is planned;
  300. the waitlist is in the app.
  301. **Does it work offline?** Once the page is open, drawing, the code panel and exports run in the
  302. page. AI, share links and repo maps need the network. For no internet at all, self-host it.
  303. **Which browsers?** A current desktop browser with WebGL. The automated tests run in Chromium.
  304. **Can my team edit together?** Not in real time. A view-only link is a snapshot, an editable
  305. link hands each person their own copy, and `.openflow.json` and `.ofk` files live happily in git.
  306. More: [FAQ](https://docs.openflowkit.com/faq/).
  307. </details>
  308. ## Contributing
  309. Issues, ideas and PRs are welcome. Start with [CONTRIBUTING.md](CONTRIBUTING.md) for setup and
  310. the checks, and [ARCHITECTURE.md](ARCHITECTURE.md) for how the code fits together. Questions go to
  311. [Discussions](https://github.com/openflowkit/openflowkit/discussions). What changed in each
  312. version: [CHANGELOG.md](CHANGELOG.md).
  313. Report security issues privately, as [SECURITY.md](SECURITY.md) describes. MIT licensed, see
  314. [LICENSE](LICENSE).
  315. <a href="https://github.com/openflowkit/openflowkit/graphs/contributors"><img src="https://contrib.rocks/image?repo=openflowkit/openflowkit&max=100" alt="Contributors"></a>
  316. ---
  317. <p align="center">
  318. <a href="https://app.openflowkit.com"><img src="public/Logo_openflowkit.svg" width="40" height="40" alt="OpenFlowKit logo"></a>
  319. </p>
  320. <p align="center">
  321. <b>If OpenFlowKit saved you a diagram, <a href="https://github.com/openflowkit/openflowkit">give it a ⭐ on GitHub</a>.</b><br>
  322. <sub>It's how other people find it.</sub>
  323. </p>
  324. <p align="center">
  325. <a href="https://app.openflowkit.com">Open the app</a> &nbsp;·&nbsp;
  326. <a href="https://docs.openflowkit.com/">Docs</a> &nbsp;·&nbsp;
  327. <a href="CONTRIBUTING.md">Contribute</a> &nbsp;·&nbsp;
  328. <a href="https://github.com/openflowkit/openflowkit/discussions">Discussions</a> &nbsp;·&nbsp;
  329. <a href="https://github.com/openflowkit/openflowkit/issues/new/choose">Report a bug</a>
  330. </p>

Ratings and comments

Sign in to rate this skill.

Sign in

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