@inkly-org/cli

Pitch-ready demos from one prompt.

The command-line companion to Inkly — the AI-native interactive demo tool you build once and iterate with AI.

Your demos are yours, as code, living right next to your product. Scaffold a demo hub, preview it locally, capture a walkthrough, and ship it — all from your terminal. Then keep it alive by pointing your coding agent (Claude, Cursor, Codex) at the demo files, or with the no-code editor on the web.

Requirements

• Node.js ≥ 20

Install

npm install -g @inkly-org/cli

Use the installed inkly binary for all commands. Avoid running Inkly through npx, especially capture commands, because one-off execution can resolve Chrome differently and cause browser launch failures.

Quick start

inkly init my-hub      # scaffold a new demo hub
cd my-hub
inkly add checkout     # add a demo to the hub
inkly dev              # preview at http://localhost:3000

A hub is just files: an inkly.json at the root and one demos/<slug>/demo.config.json per demo. Commit them to your repo and your agent can author and maintain them directly — no rebuild, no lock-in.

Capture

Every demo is a sequence of steps. Capture a pixel-perfect walkthrough of a real site — image/video or self-contained HTML, recorded by driving a real browser. The default for product tours; preview with inkly dev and publish with inkly snapshot.

Point your coding agent at the Inkly skills to build one: the index skill at https://www.app.inklyai.dev/__inkly/skills/inkly.md routes it to the focused capture playbook.

Commands

Run inkly help <command> (or inkly <command> --help) for full options.

Authoring

| Command | What it does | |---|---| | inkly init <name> [--layout sidebar\|tabs] | Scaffold a new demo hub. | | inkly add <name> [--collection <name>] | Add a demo to the current hub. Gets a fresh, permanent id. | | inkly dev [--port <n>] | Start the local preview server (defaults to port 3000). | | inkly validate [--json] [--strict] | Validate the hub and demo files. | | inkly doctor [--json] | Run local diagnostics and repair demo ids. |

--collection is optional — a demo joins a collection only when you ask. Omit it and the demo stays uncollected.

Capture

Generate a walkthrough of any live site for an external browser agent to turn into a demo. Both commands run real Chrome (headless by default) and print JSON.

| Command | What it does | |---|---| | inkly capture <start\|stop\|cancel\|profiles> | Capture an image/video walkthrough. | | inkly capture-html <start\|stop\|cancel\|profiles> | Capture a self-contained HTML walkthrough. |

inkly capture start --url https://example.com --name my-demo
inkly capture stop  --session <id> --out ./out

Useful flags: --headed (watch a login), --profile <name> (reuse a signed-in Chrome profile across captures), --width/--height, --timeout <ms>. HTML capture adds --block-videos, --compress-images, and --subset-fonts.

Connect to Inkly

| Command | What it does | |---|---| | inkly login | Connect to the hosted app. | | inkly logout | Remove saved credentials. | | inkly status [--json] | Show auth and hub status. | | inkly sync [--demo <slug>] [--dry-run] | Upload local capture assets to the CDN. | | inkly snapshot <demo> [--yes] | Publish a standalone /p/<id> snapshot. |

Maintenance

| Command | What it does | |---|---| | inkly lock [--check] [--json] | Generate or verify inkly.lock, which pins the exact runtime your demos render with. | | inkly version | Print the CLI version. | | inkly update [--dry-run] | Update the globally installed CLI. |

How it fits together

The CLI is one of Inkly's three authoring surfaces — alongside the visual editor and your own AI agent — over a single git-backed substrate. Whatever you scaffold here is the same JSON your agent edits and the same source the hosted hub renders. Bring your own agent; own your demos.

License

Proprietary. © Inkly. All rights reserved.