CLI reference

Ce contenu n’est pas encore disponible dans votre langue.

Overview

The nowline command-line tool parses .nowline files and produces visual output. It is the primary interface for m2 and the foundation that all other tools build on.

The CLI is verbless by design: nowline <input> renders by default. Operations that aren’t render are flags on the same invocation (--serve, --init, --dry-run). One shape, one CLI surface — matching the convention used by mmdc, dot, d2, pandoc, prettier, tsc.

Package: @nowline/cli in lolay/nowline monorepo. License: Apache 2.0. Milestones: the CLI ships in three parts: m2a (scaffold + validate / convert / init / version verbs + distribution pipeline), m2b (render + serve verbs, SVG output), m2b.5 (verbless redesign — current shape), m2c (every other output format on the same verbless invocation). m4.8 adds --mcp (MCP server mode; see below). Each depends on m1 DSL.

Installation

Package Managers

Platform	Command
macOS	`brew trust lolay/tap && brew install lolay/tap/nowline`
Linux / WSL	`brew trust lolay/tap && brew install lolay/tap/nowline` or download `.deb` from GitHub Releases
Windows	Direct download from GitHub Releases (`.exe`)
npm (any platform)	`npm install -g nowline`

Each of the Unix paths (Homebrew, .deb, npm) ships the packages/cli/man/nowline.1 and packages/cli/man/nowline.5 man pages, so man nowline (CLI flags + LANGUAGE cheatsheet) and man 5 nowline (full DSL reference) both work immediately after install. See specs/cli-distribution.md for the per-channel install layout.

Standalone Binaries

bun compile produces self-contained binaries (~55MB) with no runtime dependency. Published as GitHub Release assets for:

macOS arm64 (Apple Silicon)
macOS x64 (Intel)
Linux x64
Linux arm64
Windows x64
Windows arm64 (Parallels, Snapdragon laptops)

A single nowline binary ships per platform with every export format bundled — see specs/cli-distribution.md. (The original m2c plan was a tiny/full split; that decision was reversed after measuring that the bun runtime dominates compiled-binary size.)

CLI Surface

nowline <input> [options]

  <input>                Path to .nowline or .json file, or `-` for stdin
                         (required unless --init or --version or --help)

I/O options
  -f, --format <fmt>     Output format: svg, png, pdf, html, mermaid, xlsx, msproj
                         Default: inferred from -o extension, else .nowlinerc
                         `defaultFormat`, else svg
  -o, --output <path>    Output file path. Use `-` for stdout (Unix dash convention)
                         Default: <cwd>/<input-base>.<format>
                         Overwrites existing files without prompting.
  --input-format <fmt>   Force input format: nowline | json (default: by extension)

Mode flags (mutually exclusive)
  --serve [-p <port>]    Live HTTP preview; -o opt-in writes output on each rebuild
                         Default port: 4318. --open to open browser.
  --init [<name>]        Scaffold a starter .nowline file; positional becomes name
                         Default: roadmap.nowline in cwd
  --dry-run, -n          Run full pipeline (parse + validate + layout + format)
                         but skip the write step. Subsumes the old `validate` verb.
                         Exit 0 on success, 1 on validation error.
  --mcp [--port <n>]     Start an MCP server in stdio mode (default) or local Streamable HTTP
                         (`--port`). Exposes the CLI's capabilities as a typed MCP
                         tool surface. `npx @nowline/mcp` is the canonical
                         harness-install path; `nowline --mcp` is the power-user
                         equivalent. See [`specs/mcp.md`](./mcp.md).

Render options
  -t, --theme <name>     light | dark | grayscale (greyscale alias)
  --now <date>           "Now" anchor for the now-line. Accepted forms:
                           YYYY-MM-DD                   — floating date (zone-independent)
                           YYYY-MM-DDTHH:MM:SSZ         — UTC instant; embedded Z wins
                           YYYY-MM-DDTHH:MM:SS±HH:MM    — fixed-offset instant; offset wins
                           YYYY-MM-DDTHH:MM:SS          — floating datetime; date part used
                         Default: today's local civil date (or --timezone if set).
                         Pass `--now -` to suppress the now-line entirely
                         (Unix-`-` sentinel; same convention as `-o -`).
  --timezone <zone>      Timezone for the clock-based "today" default. Only
                         consulted when --now is omitted; ignored when --now
                         carries an explicit date or embedded ISO offset.
                         Accepted forms:
                           local                        — host zone (default)
                           UTC                          — UTC
                           Z, +00:00                    — zero-offset (= UTC)
                           ±HH, ±HH:MM, ±HHMM          — fixed offset (DST-naive)
                           America/Los_Angeles          — IANA timezone name
                         Ambiguous abbreviations (PST, IST, …) are rejected on
                         most platforms; use IANA names for portable scripts.
  --no-links             Omit link icons from output
  -s, --scale <n>        Raster scale factor (PNG only; default 1)
  --strict               Promote asset / sanitizer warnings to errors
  -w, --width <px>       Canvas width in pixels (default: 1280)
  --asset-root <dir>     Directory from which logo / image assets may be loaded

Format-specific options
  --page-size <size>     PDF page size: preset (letter | legal | tabloid |
                         ledger | a1..a5 | b3..b5), `content` for auto-fit,
                         or `WxHunit` for custom (e.g. 8.5x11in, 210x297mm).
                         Default: letter.
  --orientation <name>   PDF orientation: portrait | landscape | auto.
                         Default: auto.
  --margin <length>      PDF page margin. Bare numbers are points;
                         length suffixes (in, mm, cm) are accepted.
                         Default: 36pt (½ inch).
  --font-sans <ref>      Sans font for PNG/PDF: TTF/OTF path, or alias
                         (sf, helvetica, dejavu, etc.). Default: platform
                         probe → bundled DejaVu fallback.
  --font-mono <ref>      Mono font for PNG/PDF. Default: same as --font-sans
                         resolution chain.
  --headless             Skip platform font probe; force bundled DejaVu pair.
                         Byte-stable across machines.
  --start <date>         MS Project: anchor date (YYYY-MM-DD) for relative
                         roadmaps. Default: --now, then deterministic
                         fallback.

Logging (mutually exclusive)
  -v, --verbose          Print extra diagnostics to stderr (config path,
                         pipeline timings, font resolution, fallback decisions)
  -q, --quiet            Suppress non-error stderr

Standard
  -h, --help             Print help and exit 0
  -V, --version          Print version and exit 0

nowline with zero arguments prints help and exits 0 (matches git, kubectl, gh, cargo, docker). nowline -f pdf (has flags, no input) exits 2 with a “missing input file” error.

-V (uppercase) is --version; lowercase -v is --verbose. Matches curl / ssh / wget / gpg convention.

Examples

nowline roadmap.nowline                          # writes ./roadmap.svg in cwd
nowline roadmap.nowline -f pdf                   # writes ./roadmap.pdf in cwd
nowline roadmap.nowline -o roadmap.pdf           # format inferred from extension
nowline roadmap.nowline -o -                     # stdout (Unix `-` convention)
nowline roadmap.json -f svg                      # JSON-AST input
cat foo.nowline | nowline -                      # stdin → ./roadmap.svg
nowline roadmap.nowline -f json -o roadmap.json  # convert (no separate verb)
nowline roadmap.nowline --dry-run                # validate-only; no file written
nowline roadmap.nowline --serve -p 8080          # live preview server
nowline --init                                   # scaffold ./roadmap.nowline
nowline --init my-project                        # scaffold ./my-project.nowline
nowline roadmap.nowline -f pdf -o report         # writes report.pdf (auto-extension)
nowline                                          # no args → prints help, exits 0

Mode Flags

Default — render

nowline <input> [options]. Renders <input> to the resolved format and writes to the resolved output path. This is the most common operation.

`--serve`

Start a local dev server that watches a .nowline file and live-reloads the rendered output in the browser. Primarily for editors without a native preview panel (Neovim, Emacs, Sublime, etc.).

nowline roadmap.nowline --serve
nowline roadmap.nowline --serve --port 4400 --theme dark
nowline roadmap.nowline --serve -o roadmap.svg     # also writes file on each rebuild

Options:

Flag	Default	Notes
`-p, --port <n>`	`4318`	Port to bind
`--host <host>`	`127.0.0.1`	Interface; `0.0.0.0` exposes on the LAN
`--open`	off	Open the browser on start
`-o, --output <path>`	none	Opt-in: also write the rendered output to this path on every rebuild. `-o -` is rejected for `--serve`.

--serve rejects --dry-run.

`--init [<name>]`

Scaffold a starter .nowline file in the current directory.

nowline --init                       # writes ./roadmap.nowline
nowline --init my-project            # writes ./my-project.nowline (extension appended)
nowline --init my-project.nowline    # writes ./my-project.nowline (literal)
nowline --init -o ./roadmaps/q1.nowline   # -o overrides path

The positional argument is the project name, not an input path.

No extension → append .nowline.
Already .nowline → literal.
Other extension → exit 2 with nowline: --init only scaffolds .nowline files; got "...".
Missing positional → name roadmap.
-o always overrides the default path.

Existing files at the destination are silently overwritten.

--init rejects --dry-run.

`--dry-run` (`-n`)

Run the full pipeline (parse + validate + layout + format) but skip the write step. Replaces the old nowline validate verb. Works with any format — nowline roadmap.nowline -f pdf --dry-run exercises the PDF exporter without producing a file.

nowline roadmap.nowline --dry-run                     # validate .nowline → svg pipeline
nowline roadmap.nowline -f pdf --dry-run              # validate full PDF pipeline (m2c)
nowline roadmap.nowline --dry-run --format=json       # JSON diagnostics on stderr

Exit 0 on success, 1 on validation error.

`--mcp [--port <n>]` (m4.8)

Start a local MCP server that exposes the CLI’s capabilities as a typed MCP tool surface.

nowline --mcp                         # stdio server (default; harness spawns and talks stdin/stdout)
nowline --mcp --port 6789             # local Streamable HTTP server (for harnesses that prefer HTTP transport)

Default transport is stdio — the harness spawns nowline --mcp (or npx @nowline/mcp) and communicates over stdin/stdout. This is the MCP CLI form. The --port flag switches to local Streamable HTTP (the deprecated standalone SSE transport is not offered), for harnesses that prefer an HTTP transport instead of stdio.

The server exposes the eight shared-contract tools (validate, render, read, create, update, delete, list, export) — names intentionally identical to the Nowline Cloud MCP server contract, so agents graduate from local to cloud with zero relearning — plus OSS conveniences (convert, capabilities, and the granular list-themes / list-icons / list-locales / list-formats / list-templates discovery family), three resources (nowline://reference, nowline://examples, nowline://conversions), and three prompts (create-roadmap, fix-diagnostics, convert-to-nowline). Full surface: specs/mcp.md.

CLI-design note for review: --mcp is a mode flag on nowline (like --serve and --init) rather than a verb on the separate @nowline/mcp package. The separate package (npx @nowline/mcp) is the canonical install path for harness configs because it decouples the MCP server’s install lifecycle from the CLI binary — a harness using npx @nowline/mcp always gets the published npm version, whereas nowline --mcp uses whatever binary the user has installed. Either form is valid; npx @nowline/mcp is preferred in MCP config examples. See specs/mcp.md.

--mcp rejects --serve, --init, and --dry-run.

`--version` / `-V` and `--help` / `-h`

Print version or help to stdout and exit 0. Combined with any other flag, the standard flag wins (matches GNU coreutils).

Behavior Contracts

Format resolution

Precedence chain (first hit wins):

-f / --format flag — explicit always wins.
-o <path> extension — recognized output extension.
.nowlinerc defaultFormat — project-level default.
svg — built-in fallback.

Recognized extension → format map (also the canonical-extension table for auto-add):

Extension	Format
`.svg`	`svg`
`.png`	`png`
`.pdf`	`pdf`
`.html`, `.htm`	`html`
`.md`, `.markdown`	`mermaid`
`.xlsx`	`xlsx`
`.xml`	not inferred — ambiguous; `-f msproj` is required
any other	falls through to step 3

Conflict handling: if -f and -o extension disagree (e.g. nowline foo.nowline -f pdf -o foo.png), -f wins and the output file keeps whatever name the user wrote — no auto-rename. -o - (stdout) skips step 2 entirely.

Output extension auto-add

After format is resolved, the output path may be rewritten:

-o <path> ending in no extension → append the canonical extension for the resolved format. (-o report -f pdf → report.pdf.)
-o <path> ending in the canonical extension for the resolved format → use as-is.
-o <path> ending in any other extension → use as-is, no auto-rename. (-o foo.txt -f pdf writes PDF bytes to foo.txt.)
Default-named output (no -o) is unaffected.
-o - (stdout) skips auto-add.

Default output filename

All default-named outputs land in cwd, never next to the input.

Mode	Default path
Render with file input	`<cwd>/<input-base>.<format>`
Render with stdin	`<cwd>/roadmap.<format>`
Init	`<cwd>/<name>.nowline` (default name `roadmap`)
Convert (now `-f` + `-o`)	Same cwd rule

Existing files are silently overwritten — matches POSIX redirection (> file), mmdc, d2, prettier, tsc.

Stdout

-o - is the only way to write to stdout (Unix dash convention; matches mmdc, d2, pandoc, ffmpeg).
Textual formats (svg, html, mermaid, json, .nowline, msproj) always work on stdout.
Binary formats (png, pdf, xlsx) on stdout: work if stdout is a pipe; refused with exit 2 if stdout is a TTY (nowline: binary output (png) to terminal refused; use -o or pipe to a file). Curl convention.

Input

Detected by extension: .nowline → DSL, .json → AST.
--input-format overrides for unusual filenames or stdin.
Stdin (-) defaults to .nowline.
The standard -- “end of options” marker handles filenames that start with -.

Diagnostics

Default text format renders biome / oxc-style frames via @babel/code-frame:

roadmap.nowline:7:34 error: Unknown reference 'auth-refactro' in after — did you mean 'auth-refactor'?
  5 |   item auth-refactor "Auth refactor" size:l
  6 |   parallel after:auth-refactor
> 7 |     group audit-track "Audit Track" labels:security
    |                                     ^^^^^^^^^^^^^^^
  8 |       item audit-log "Audit log v2" size:xl before:code-freeze

JSON diagnostics (--format=json on --dry-run) emit { "$nowlineDiagnostics": "1", "diagnostics": Diagnostic[] }. Diagnostic shape:

type Diagnostic = {
  file: string;
  line: number;        // 1-based
  column: number;      // 1-based
  severity: 'error' | 'warning';
  code: string;
  message: string;
  suggestion?: string;
};

Exit Codes

Code	Meaning
0	Success
1	Validation error (parse failure, invalid references)
2	Usage error (missing input, invalid flags, mutually-exclusive flags, format unavailable in this build, binary output to TTY, file not found, unreadable input)
3	Output error (cannot write to destination, exporter pipeline failure)

Piping and Composability

The CLI is designed for Unix composability:

# Pipe SVG to clipboard (macOS)
nowline roadmap.nowline -o - | pbcopy

# Validate all .nowline files in a directory
find . -name '*.nowline' -exec nowline {} --dry-run \;

# Render to PNG and open
nowline roadmap.nowline -f png -o /tmp/roadmap.png && open /tmp/roadmap.png

# Pipe AST JSON to jq for analysis
nowline roadmap.nowline -f json -o - | jq '.ast.roadmapEntries[]'

# Convert JSON AST back to .nowline text
nowline roadmap.json -f nowline -o roadmap.nowline

Configuration

The CLI reads an optional .nowlinerc file (JSON or YAML) from the current directory or any parent directory:

{
  "theme": "dark",
  "defaultFormat": "svg",
  "width": 1200,
  "quiet": false
}

CLI flags override config file values. The narrow exception is locale (see below): Nowline honors LC_ALL / LC_MESSAGES / LANG because every Unix tool author’s man page reader, terminal, and OS already does. Other environment variables are not supported in m2 — keep it simple.

The defaultFormat key participates in the format-resolution chain (step 3): used when neither -f nor a recognized -o extension is present.

Localization

Nowline localizes axis tick labels, the now-pill text, the quarter prefix, footnote sort, validator messages, and the man page. DSL keywords stay English/ASCII.

Two independent locale chains, one per surface:

Content chain (the rendered SVG / PDF / etc.): file’s nowline v1 locale: directive → --locale → LC_ALL / LC_MESSAGES / LANG → .nowlinerc locale → en-US. The file always wins for the artifact so a French roadmap stays French regardless of the operator’s shell — same idea as HTML’s lang and AsciiDoc’s :lang:.
Operator chain (terminal output: validator diagnostics, --help, errors, verbose logs): --locale → LC_ALL / LC_MESSAGES / LANG → .nowlinerc locale → en-US. The file’s directive never enters this chain — operator-facing text follows the operator’s environment.

Bundles follow the CLDR locale tree (root → fr → {fr-CA, fr-FR}); the loader strips trailing subtags and retries, so any future fr-BE resolves through fr for free. See specs/localization.md for the resolution matrix, bundle layout, fallback chain, error-code policy, and translation strategy.

Distribution Pipeline

npm publish: @nowline/cli published to npm. Users can npx nowline roadmap.nowline without global install.
GitHub Releases: bun compile binaries attached to each GitHub Release tag. Windows .exe binaries (x64, arm64) are the primary Windows distribution — direct download, no package manager needed.
Homebrew: Custom tap (lolay/tap) with a formula that downloads the macOS or Linux binary. Also works in WSL.
apt: .deb packages published to a PPA or GitHub Releases.

A single nowline binary per platform bundles every export format — see specs/cli-distribution.md for the rationale (post-measurement reversal of the original m2c § 11 tiny/full split).

Binary Size Budget

Ceilings are per target, asserted in CI by packages/cli/scripts/compile.mjs. The bun standalone runtime varies by ~50 MB across platforms — darwin-arm64 ships ~60 MB, linux-x64 with glibc compat shims is ~95 MB, and windows-x64 is ~110 MB — so a single global ceiling would either let macOS regressions slide or fail every Linux/Windows build. Each target gets ~5–8 MB headroom over its current measurement.

Target	Measured	Ceiling
`darwin-arm64`	~70 MB	80 MB
`darwin-x64`	~75 MB	85 MB
`linux-x64`	~107 MB	115 MB
`linux-arm64`	~107 MB	115 MB
`windows-x64`	~122 MB	130 MB
`windows-arm64`	~119 MB	125 MB

Comparable runtimes: Deno (~40 MB), Bun standalone (~50 MB) — acceptable for a developer tool installed once. See specs/cli-distribution.md for the measurement breakdown that ruled out a tiered split. The npm package is much smaller since it relies on the user’s own Node.js / Bun runtime.