Inkline
Menu

Inkline for VS Code

Keep diagrams next to your code. Write .ink files with highlighting and problems as you type, and see the drawing beside the editor.

checkout.ink — VS Code with the Inkline extensionNo problems
checkout.ink
diagram architecture "Checkout platform"
  direction right
  theme slate

  person shopper "Customer"
  zone aws "AWS eu-west-1" {
    service api    "Orders API"   use=aws/ecs
    store   orders "Orders DB"    use=aws/rds
    queue   events "Order events" use=aws/sqs
    fn      mailer "Email worker" use=aws/lambda
  }

  shopper -> api    : HTTPS
  api     -> orders : SQL
  api     ~> events : publish  # ~> is async
  events  ~> mailer : consume
Inkline preview
The preview is drawn by the engine from the text on the left — the same picture the CLI makes.

What it does

  • Syntax highlighting

    All six diagram types — architecture, flow, sequence, ERD, class and state — including the AI building blocks (llm, agent, tool, mcp, vectordb …) and UML relations like --|> and *--.

  • Problems as you type

    The engine checks the file 200 ms after you stop typing. Each problem has a stable code (INK1xxx syntax, INK2xxx meaning) and points at the exact place.

  • Live preview

    “Inkline: Open Preview to the Side” follows the active .ink file and redraws as you type. Zoom with the toolbar or Ctrl + mouse wheel.

  • Export

    “Export as SVG” and “Export as PNG” write the file next to your .ink. For print-quality PNG or PDF, use the CLI: ink render file.ink -o file.pdf.

  • Format Document

    Shift + Alt + F tidies spacing and alignment with the same formatter as ink fmt. Files with syntax errors are left untouched.

  • Same engine everywhere

    The extension runs @inkline/engine, so a file previews exactly as the CLI, the web editor and the render API draw it.

Install

From the Marketplace

Search for “Inkline” in the Extensions view, or open the listing: [MARKETPLACE-LINK] (published with the 0.1 release).

Needs VS Code 1.95 or newer.

From a .vsix file

Build the package from the repository and install it directly:

# from a clone of the Inkline repository
$ pnpm install
$ pnpm --filter inkline-vscode run package
$ code --install-extension apps/vscode/dist/inkline.vsix

Or in VS Code: Extensions view → “…” menu → Install from VSIX… and pick inkline.vsix.

Settings

SettingDefaultMeaning
inkline.preview.themesourceUse the file’s theme line, or always slate, light or dark.
inkline.validateOnTypetrueCheck while typing. When off, files are checked on open and save.

The preview runs under a strict Content-Security-Policy and shows the diagram as an image, so nothing inside a file can run code. Prefer the terminal? Install the CLI.