Home
Contents

Quick Start

Install takumi-render, write a card in HTML, and render it with a font directory.

Requirements§

You need Linux x86_64 for the prebuilt binary, or Rust 1.91 or newer to build from source.

Takumi Render does not need Node.js, npm, or WebAssembly at runtime. It does need at least one font file because Takumi does not load system fonts.

Install§

Install the latest Linux x86_64 prebuilt binary with the installer:

curl -fsSL https://raw.githubusercontent.com/gicrisf/takumi-render/main/install.sh | bash

The installer places takumi-render in ~/.local/bin. See Installation for pinned versions, manual downloads, and other installation options.

Write a card§

Create card.html. Set explicit dimensions on the root element so the layout fills the image:

<!doctype html>
<html>
<body style="margin:0">
  <div style="width:1200px;height:630px;display:flex;align-items:center;justify-content:center;background:#ececec;font-family:'IBM Plex Mono',monospace">
    <h1 style="font-size:72px">Hello from Takumi</h1>
  </div>
</body>
</html>

The font family name must match a font registered from --fonts-dir.

Render the card§ 

takumi-render render \
  --html card.html \
  --output card.png \
  --fonts-dir path/to/fonts

The default image is 1200×630. Override it with --width and --height:

takumi-render render \
  --html card.html \
  --output card.png \
  --width 800 \
  --height 400 \
  --fonts-dir path/to/fonts

To read HTML from standard input, use --html - or omit --html:

cat card.html | takumi-render render --output card.png --fonts-dir path/to/fonts

Batch mode§

For many cards, use a manifest so fonts load once:

takumi-render batch cards.json --fonts-dir path/to/fonts

See Batch Manifests for the JSON shape.

Next steps§