# Node Lynx CLI

Runs Lynx bundles, captures screenshots, and inspects rendered content over CDP.

- Repository: https://github.com/lynx-family/lynx (15228 stars)
- Category: Engineering
- License: Apache-2.0
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add lynx-family/lynx --skill node-lynx -g -a claude-code -y`
Codex: `npx skills add lynx-family/lynx --skill node-lynx -g -a codex -y`
Cursor: `npx skills add lynx-family/lynx --skill node-lynx -g -a cursor -y`
Gemini CLI: `npx skills add lynx-family/lynx --skill node-lynx -g -a gemini-cli -y`

## Description

Use this skill when a task needs to run Lynx bundles with the node-lynx CLI, capture screenshots, open a macOS preview window, use DebugRouter OpenCard, inspect rendered content through CDP, or integrate node-lynx through JavaScript or TypeScript APIs.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Node Lynx

Use node-lynx as a local Lynx runtime for screenshots, preview windows, smoke
tests, DebugRouter OpenCard sessions, and automation that needs to inspect or
interact with a rendered Lynx page from Node.js.

Default sample template URL:

```text
https://lynxjs.org/lynx-examples/gallery/dist/GalleryComplete.lynx.bundle
```

## CLI

Prefer the CLI for one-off screenshots, quick template validation, and simple
preview sessions.

Show available options:

```bash
node-lynx --help
```

Capture a headless screenshot and exit:

```bash
node-lynx render \
  "https://lynxjs.org/lynx-examples/gallery/dist/GalleryComplete.lynx.bundle" \
  --width 268 \
  --height 469 \
  --dpr 2 \
  --output ./gallery.png \
  --timeout 30000 \
  --screenshot-delay 500 \
  --no-debug-router
```

Render a local bundle:

```bash
node-lynx render \
  --template ./dist/main/template.js \
  --width 390 \
  --height 844 \
  --output ./node-lynx-local.png \
  --no-debug-router
```

Open a visible preview window on macOS:

```bash
node-lynx preview \
  "https://lynxjs.org/lynx-examples/gallery/dist/GalleryComplete.lynx.bundle" \
  --width 268 \
  --height 469 \
  --dpr 2 \
  --title "Node Lynx Preview"
```

Start a DebugRouter-backed session without an initial template:

```bash
node-lynx render
```

CLI rules:

The rest: https://github.com/lynx-family/lynx/blob/HEAD/oliver/node-lynx/skills/node-lynx/SKILL.md