Skip to content

fizznix/excalidraw-gen-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

excalidraw-gen — Agent Skill

An agent skill that generates Excalidraw diagram files from a structured JSON or YAML description. Compatible with any agent that supports SKILL.md-based skills (GitHub Copilot, Cursor, and others).

What it does

When you ask your agent for a diagram, flowchart, architecture diagram, pipeline, or any visual graph, this skill guides it to:

  1. Classify the diagram type (flowchart vs architecture)
  2. Enumerate nodes and edges from your description
  3. Author a valid input file (JSON or YAML)
  4. Invoke the excalidraw-gen CLI to produce a .excalidraw file

Repository structure

excalidraw-gen-skill/
├── README.md               ← you are here
└── excalidraw-gen/         ← skill package (folder name must match the skill name)
    ├── SKILL.md            ← skill entry point + CLI reference
    ├── schema.md           ← full input file schema
    ├── node-types.md       ← all node type values
    ├── style-overrides.md  ← per-node/edge style fields & colour palette
    ├── validation.md       ← validation rules (errors vs warnings)
    ├── examples.md         ← annotated JSON & YAML examples
    └── agent-workflow.md   ← step-by-step agent checklist

Using the skill

Once the skill is available to your Copilot agent, simply ask for a diagram:

"Draw a flowchart for a user login process using excalidraw skill"
"Generate an architecture diagram for a microservices backend using excalidraw skill"

The agent will produce an input file and run:

npx excalidraw-gen generate <input-file> --template flowchart --out diagram.excalidraw

Open the resulting .excalidraw file at excalidraw.com or in the Excalidraw desktop app.

CLI options

Option Values Default
--template flowchart | architecture flowchart
--theme default | pastel | dark default
--layout dag | grid dag
--out path to output file stdout
--max-nodes number 200

Template guide

Ask for... Template
Workflow, process, decision tree, pipeline, state machine flowchart
System diagram, service map, infrastructure, data flow architecture

Skill reference files

File Purpose
SKILL.md Entry point — overview, CLI usage, template rules
schema.md Input file schema reference
node-types.md Node type catalogue
style-overrides.md Styling & colour palette
validation.md Validation rules
examples.md Worked examples
agent-workflow.md Agent checklist

About

Skill to plugin with your agents for using the excalidraw-gen tool for generating excalidraw diagrams

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors