Inkline
Menu

Install the CLI

One command to install. Diagrams are drawn on your machine, and your files stay there.

1. Install

$ npm install -g inkline
$ ink --version

Needs Node.js 22 or newer. Or run it once with npx inkline render …

2. Draw something

$ ink init
$ ink render example.ink -o example.png
$ ink render example.ink -o example.svg --theme light
$ ink validate example.ink

ink init writes a starter example.ink. Edit it in any editor and render again, or paste it into the playground.

3. Keep diagrams fresh in CI Week 9

.github/workflows/diagrams.yml
- uses: [YOUR-ORG]/inkline-render-action@v1
  with:
    files: "docs/**/*.ink"
    format: "svg,png"
    scale: 2
    commit: true

Every merge redraws changed diagrams and commits the images next to the text.

Next steps