尚未检测到更新。GitHub 发布版本后会显示在这里。
制作者的介绍仅有上面的一句话。 更多详情请阅读仓库 README。 仓库 README ↗
正在加载完整 README。
查看完整 README ↗When you ask an AI assistant for a diagram, it usually writes every line, box and coordinate by hand. That is slow, uses up a lot of your AI usage, and every diagram looks different.
With sysketch, the AI writes a short description of your system and sysketch draws it.
sysketch connects to AI assistants through MCP, the standard way to give them new tools. Pick the option that matches how you use AI.
Any web-based AI chat that supports custom connectors (also called MCP servers) can use sysketch, including Claude, ChatGPT and Perplexity. Add a custom connector with this URL. No account or sign-in is needed.
https://sysketch.vercel.app/mcp
Then ask for a diagram:
Use sysketch to draw a ride-sharing app: rider and driver apps, an API gateway, a matching service, a location service and a trip database.
In Claude and ChatGPT the diagram opens right in the chat, with zoom, fullscreen and PNG/SVG download buttons. Other chats show a preview with links to the full PNG and SVG. To change it, just ask ("add a payment service"). Product names like stripe, kafka or postgres show the product's official logo (from Simple Icons). Nothing is stored on the server: each link contains the diagram's description, so anyone with the link can see that diagram. The AWS, Azure and Google Cloud icon packs and your own company's logos need the local version below. Setup and the connector's limits are in the hosted server guide.
This runs sysketch on your computer and saves diagrams straight into your project. You need Node.js 20 or newer.
Claude Code: run this once in your terminal:
claude mcp add sysketch -- npx -y sysketch-mcp
Claude Desktop, Cursor and other assistants: add this to the assistant's MCP settings, then restart it:
{
"mcpServers": {
"sysketch": { "command": "npx", "args": ["-y", "sysketch-mcp"] }
}
}
Claude Desktop saves diagrams in a sysketch folder in your home folder. To use another folder, add "--dir", "/path/to/folder" after "sysketch-mcp".
Then ask the same way, for example "use sysketch to draw this repo's architecture as a PNG". The diagram is saved in your project as an image, along with its short description, so you can ask for changes later. This version also supports official logos.
You need Node.js 20 or newer. Write a description of your system in a file called diagram.yaml:
title: URL Shortener
groups:
Backend: [api, cache, db]
edges:
- client > lb | POST /shorten
- lb > api
- api > cache
- api > db
Then draw it:
npx sysketch render diagram.yaml
That creates diagram.svg:
Add --png for an image file, or --theme graphite for a different look.
A diagram has three parts. Only edges is required.
| Part | What it does | Example |
|---|---|---|
edges | Arrows between parts of your system | client > lb > api | GET /home |
nodes | Optional names, icons and notes | api: server | API Server | 3 replicas |
groups | Optional boxes around related parts | Backend: [api, cache, db] |
Common names like client, api, db, cache, queue, redis, kafka, s3 or stripe pick the right icon automatically. You can also use dashed (..>), two-way (<>), thick (=>) and plain (--) arrows, colors, groups inside groups for cloud networks, a numbered step legend, and type: sequence for sequence diagrams. Everything is in the spec guide.
If something is wrong, sysketch says how to fix it: unknown node "databse". Did you mean: database?
| Sketch (default) | Graphite | Blueprint | Midnight | Classic |
|---|---|---|---|---|
Pick one with theme: graphite in your diagram file, or ask your assistant for "the blueprint theme". Every diagram includes 61 original icons that adapt to the theme.
Click any diagram to see the description that produced it. More in examples/.
以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗