@markdy/cli

First-party command-line tooling for MarkdyScript.

Install

npm i -D @markdy/cli

If you install it into a project, run it with npx markdy ... or npm exec markdy ... from that project. To make markdy available as a shell command everywhere, install it globally with npm i -g @markdy/cli.

Package position (text)

@markdy/cli
	-> reads .markdy files from disk
	-> uses parser/runtime packages internally
	-> outputs diagnostics, formatted source, or rendered HTML

Output preview

Use this command to generate a local HTML preview:

npx markdy render examples/showcase/bullet-reveal.markdy --out examples/xscene.html

Commands

markdy                 # launch a local browser playground on http://127.0.0.1:4242
markdy lint scene.markdy
markdy fmt scene.markdy
markdy fmt scene.markdy --write
markdy render scene.markdy --out dist/scene.html
markdy explain scene.markdy
markdy new explainer demo.markdy
markdy docs
markdy ai
markdy check-all .

Notes

• The CLI resolves import "file.markdy" as ns from disk before parsing.
• fmt prints a canonicalized scene and may expand higher-level sugar into its parsed form.
• render --out writes a self-contained HTML preview to the exact path you pass in.
• If the path is relative, it is resolved from the current working directory.
• If you see zsh: command not found: markdy, the package is installed locally but that directory is not on your PATH.