Skip to content

CLI usage

Install

bash
npm install -g @pixel-dsl/cli
# or run ad-hoc: npx @pixel-dsl/cli build ...

Commands

bash
pixel-dsl build <input.pix> -o <output.png> [options]

Options

FlagDescriptionDefault
-o, --output <path>output PNG path (required)
-s, --scale <n>nearest-neighbor upscale factor (positive integer)1
--sprite <name>sprite to render when the file declares multiplefirst sprite
-w, --watchrebuild whenever the input file changes (runs until interrupted)off

Exit codes

CodeMeaning
0Success — PNG written
1Compile/render error — diagnostic on stderr
2Bad CLI flag

Examples

bash
pixel-dsl build hero.pix -o hero.png --scale 16
pixel-dsl build sheet.pix --sprite enemy -o enemy.png --scale 4
pixel-dsl build hero.pix -o hero.png --scale 16 --watch

Diagnostic format

<file>:<line>:<col>: <severity>[<code>]: <message>
  hint: <optional hint>

This format is stable — safe to parse from scripts.