Home
Contents

Quick Start

Install the binary, render a first diagram, and run the Markdown fence transformer.

Requirements§

You need Linux x86_64 for the prebuilt binary, or Rust 1.97.0 or newer to build from source. Ondine CLI has no Node.js, npm, or WebAssembly runtime dependency.

Install§

With Cargo:

cargo install --git https://github.com/gicrisf/ondine-cli --locked --bin ondine

Prebuilt binaries are attached to each release. See Installation for the download and checksum commands.

Render a diagram§

Write Mermaid source in flow.mmd:

flowchart LR
  A[Input] --> B[SVG]

Render it beside the source file:

ondine flow.mmd

This writes flow.svg. To render standard input:

cat flow.mmd | ondine > flow.svg

To print the diagram as ASCII text instead:

ondine --ascii flow.mmd

Transform Markdown fences§

Put a Mermaid fence in Markdown:

```mermaid
flowchart LR
  A --> B
```

Transform the Markdown tree without modifying the source:

ondine markdown content --out-dir build/content

The output mirrors the input tree. Check that generated files are current:

ondine markdown content --out-dir build/content --check

See Markdown Fences for the full behavior.

Next steps§