Install

Four ways in.
One engine underneath.

However you reach for it — the plugin your agent already speaks, the CLI directly, or the skill dropped straight into your repo — it renders the same deterministic SVG.

npm i -g squinch · Node ≥ 22 · macOS / Linux / Windows
01

The Claude Code plugin

Recommended

No repo changes — updates arrive with the plugin instead of living in your tree.

/plugin marketplace add jquatier/squinch
/plugin install squinch@squinch
02

The Codex plugin

Agent plugin

The same directory, packaged as an Agent Plugin — Codex reads it, and so do Cursor, Copilot, Kiro and VS Code.

codex plugin marketplace add jquatier/squinch
codex plugin add squinch@squinch
03

The CLI

npm

One package, and the first render is two commands. macOS, Linux and Windows, on Node ≥ 22.

npm i -g squinch          # or npx squinch <cmd>

squinch init my-diagrams
squinch render my-diagrams --sync
04

The agent skill

Any harness

npx squinch skill in your project writes .agents/skills/ (plus .claude/skills/ when it detects Claude Code); --global does the same under your home directory, --print emits SKILL.md for any other harness. Then ask your agent for a diagram in plain language.

npx squinch skill
05

The VS Code extension

vsix

Download squinch-vscode-<version>.vsix from GitHub Releases and install it. The same file installs in Cursor, Windsurf and VSCodium.

code --install-extension squinch-vscode-<version>.vsix
06

CI

GitHub Action

squinch-check fails the build when a committed SVG is stale; squinch-diff comments what changed, architecturally, on the PR. Pin the version input: rendering is deterministic per tool version.

uses: jquatier/squinch/.github/actions/squinch-check@main
07

The commands

CLI reference

A path can be a single file or a directory — a directory is one project, and its files share a namespace.

checkparse + lint; --format json for agents
render--view, --theme, --adaptive, --sync, --check; -o out.png rasterizes, -o out.html exports the interactive viewer
diffsemantic model diff — --base <ref>, --format markdown, --fail-on structural|any for CI
icons searchfind an icon id across installed packs
initscaffold a starter project
skillinstall the agent skill
watchre-render on change