agentleFS
sparklabxsparklabx/drawio-ai-kit/skills/drawio/SKILL.md

drawio

Skill657 starsChanged 31 days agoMITView on GitHub

Use when the user asks for any draw.io diagram — cloud architecture (AWS, Azure, GCP, Databricks, multi-cloud, hybrid/DR, landing zone, VPC/network, serverless, data pipeline) or a business process (BPMN, swimlane, workflow with roles). Builds with the drawio-ai layout engine using real stencils, validates, and runs a render self-check. Default output is a .drawio file; PNG/SVG only on request.

  • Installs packages

25 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use excalidraw and handoff.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • lookfreeSkill

    excalidraw

    Generate architecture diagrams as .excalidraw files from codebase analysis. Use when the user asks to create architecture diagrams, system diagrams, visualize codebase structure, or generate excalidraw files.

    Also in 3 projects that use this

  • MicrosoftSkill

    handoff

    Compact the current conversation into a handoff document for another agent to pick up.

    Also in 4 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

14 rules. 0 are common, 8 are distinctive, and 6 are very specific to this project.

  • 0

    Common

    Most of the 19 edited versions we read keep these.

  • 8

    Distinctive

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Follow the steps in order.

    line 13
  2. Very specific:

    If it prints MISSING: stop.

    line 22
  3. Very specific:

    Never run npm i -g yourself.

    line 28
  4. Distinctive:

    Ask one short message with all missing questions together.

    line 42
  5. Distinctive:

    If the user said "just do it" or the request is already clear, do not ask.

    line 44
  6. Distinctive:

    Read exactly one row's files from this skill folder:

    line 50
  7. Very specific:

    Follow workflows/build.md.

    line 70
  8. Distinctive:

    Look at the PNG once. Fix what you see.

    line 78
  9. Distinctive:

    Check every box before you answer:

    line 85
  10. Very specific:

    Never write files into the kit folder (drawio-ai root).

    line 98
  11. Distinctive:

    Never invent icon names or style strings.

    line 99
  12. Distinctive:

    Never hand-write draw.io XML or x/y coordinates.

    line 100
  13. Very specific:

    Never read the engine's source (dist/, src/).

    line 101
  14. Very specific:

    Never import by file path.

    line 102

“Common” is measured: kept by at least 6 in 10 of the 19 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

draw.io diagrams

You build the diagram by writing a small Node script that uses the drawio-ai engine. The engine places every box and routes every arrow. You only declare what is inside what.

Follow the steps in order. Do not skip a step. Each step names the exact file to read — read only that file, nothing else in the kit.

Step 0 — Check the CLI

command -v drawio-ai >/dev/null 2>&1 && drawio-ai root || echo "MISSING"

If it prints MISSING: stop. Tell the user to install it, then try again:

npm i -g drawio-ai-kit

Never run npm i -g yourself.

Step 1 — Understand the request

You need these 4 facts. Take them from the user's message first.

FactExampleIf missing
DomainAWS · Azure · GCP · Databricks · multi-cloud · BPMNAsk.
What to draw"3-tier web app in one VPC, 2 AZs" · "order approval process"Ask.
Output path./docs/arch.drawioUse <cwd>/<short-name>.drawio. Do not ask. The build script goes in the same folder.
Format.drawio (default) · also .pngUse .drawio. Do not ask.

Rules for asking:

  • Ask one short message with all missing questions together. Offer choices, e.g. "Which cloud: AWS, Azure, or GCP?"
  • If the user said "just do it" or the request is already clear, do not ask. Pick the common choice and tell the user what you assumed at the end.
  • The source is a Terraform/Terramate repo? Follow workflows/from-iac.md before Step 2.

Step 2 — Pick the domain reference

Read exactly one row's files from this skill folder:

DomainReadTemplate to start from (drawio-ai scaffold --list shows all)
AWSreferences/aws-architecture.mdbuild_vpc.mjs, build_serverless.mjs, build_pipeline.mjs, build_landingzone.mjs
Azurereferences/azure-architecture.mdbuild_azure_vnet.mjs, build_azure_hub_spoke_lz.mjs
GCPreferences/gcp-architecture.mdbuild_gcp_vpc.mjs, build_gcp_shared_vpc_landing_zone.mjs
Databricksreferences/databricks-architecture.mdbuild_lakehouse.mjs, build_data_platform.mjs
Multi-cloud / hybridthe reference of each cloud involvedbuild_multicloud.mjs, build_hybrid.mjs
BPMN / swimlanereferences/bpmn.mdbuild_bpmn.mjs

Then also read:

  • references/api.md — the whole engine API on one page (every domain). Never open engine source code.
  • references/principles.md — layout rules: dense grids, flow direction, no overlaps (cloud domains; skip for BPMN).

Optional, only if you are unsure which layout fits: references/diagram-types.md. Colors and creators: references/style-guide.md.

Step 3 — Build, check, fix

Follow workflows/build.md. Short version:

  1. drawio-ai search "a, b, c" — look up all icons in one call (comma or space separated, e.g. "k8s pg es"). Use only names it returns.
  2. drawio-ai scaffold <template>.mjs -o <out-dir>/build.mjs --name <name>.drawio — copy the closest template. <out-dir> = the folder of the output path from Step 1; the .drawio lands there.
  3. Edit the tree in build.mjs. No x/y numbers.
  4. drawio-ai run <out-dir>/build.mjs — it builds, prints VALIDATE: {…}, and renders a PNG with an issues list.
  5. Fix all errors/warnings/advice/issues in one edit. Run again. Repeat until all are empty (max 5 runs).
  6. Look at the PNG once. Fix what you see. Done. (No draw.io desktop app → no PNG: skip this step.)

Can your harness run a subagent that has shell + image reading? You may hand Step 3 to it with workflows/delegate.md. Otherwise do Step 3 yourself.

Step 4 — Deliver

Check every box before you answer:

  • Built with the layout engine (group/frame/grid + icon/box + renderTree). No x/y numbers.
  • Every icon name came from drawio-ai search. No icon recolored.
  • drawio-ai validate <file>.drawio → "ok":true with empty errors, warnings, advice.
  • You looked at the rendered PNG — or, if RENDER-SKIPPED was printed, you told the user no PNG was made.
  • The file is in the user's project — never inside the kit folder (drawio-ai root).

Reply with: the .drawio path, the .png path (if any), one sentence on what the diagram shows, and any assumptions you made.

Never

  • Never write files into the kit folder (drawio-ai root).
  • Never invent icon names or style strings. Search for them.
  • Never hand-write draw.io XML or x/y coordinates.
  • Never read the engine's source (dist/, src/). references/api.md has everything.
  • Never import by file path. Scripts use import { ... } from "drawio-ai-kit" and run with drawio-ai run build.mjs.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.