{"_id":"@aretino-chant/cli","_rev":"4-7dd3bf878b4dc5a1ffd0fcb4a463816d","name":"@aretino-chant/cli","dist-tags":{"latest":"0.3.0"},"versions":{"0.1.0":{"name":"@aretino-chant/cli","version":"0.1.0","_id":"@aretino-chant/cli@0.1.0","maintainers":[{"name":"briff","email":"fodber@organum.hu"}],"bin":{"aretino":"bin/aretino.js"},"dist":{"shasum":"3f472dca1113bddf54d93f7e13826132e9ec1723","tarball":"https://registry.npmjs.org/@aretino-chant/cli/-/cli-0.1.0.tgz","fileCount":5,"integrity":"sha512-TqMHby7RIn4WpPWbZMfLpta4V63bQqjP2FsDeIbDwLsf2LrcfLSVW6j4hBddqz6/pVowAM6lpPMmBJJnNRR/kg==","signatures":[{"sig":"MEUCIQCa4xZ3HKC18tuk5zeAxgjzU8X1CaYvc4Qy9od50KZnnQIgVk+YRdinqNlDiv0ZjmKEfJsMImpQS3p5YLpk0HZWtgo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":16779},"type":"module","gitHead":"7e7319d2e8123cb3e532044569b0c2226121a43f","scripts":{"test":"node --test"},"_npmUser":{"name":"briff","email":"fodber@organum.hu"},"_npmVersion":"10.9.4","description":"Command line renderer for Aretino chant source files. It reads `.aretino` source from a file or from stdin and writes SVG to stdout or to a file.","directories":{},"_nodeVersion":"22.22.1","dependencies":{"@aretino-chant/core":"*"},"_hasShrinkwrap":false,"optionalDependencies":{"fontkit":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/cli_0.1.0_1779972540210_0.6132921045120161","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@aretino-chant/cli","version":"0.2.0","_id":"@aretino-chant/cli@0.2.0","maintainers":[{"name":"briff","email":"fodber@organum.hu"}],"bin":{"aretino":"bin/aretino.js"},"dist":{"shasum":"96f945850bf116f17711f62ad2f661e6199b9e32","tarball":"https://registry.npmjs.org/@aretino-chant/cli/-/cli-0.2.0.tgz","fileCount":5,"integrity":"sha512-bYtmwEN1WFeHUiriG5aV5ChmAWH9sCMYm28Xx//uQf26EP8fNiRLbt7fOkCDGaDG4bFMn1VGD8DudKDPTdB7eA==","signatures":[{"sig":"MEUCIQC3gDdP8H29KDSOETJBT0zTTKSUGtEHTmY7diFP4ouB5gIgGl84lm2beXMAlFzwH/Ug46sxczz7d7kgywctr95AWYA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":19416},"type":"module","gitHead":"43b421b78b881e5e04935693d89571f6abc80c5a","scripts":{"test":"node --test"},"_npmUser":{"name":"briff","email":"fodber@organum.hu"},"_npmVersion":"10.9.4","description":"Command line renderer for Aretino chant source files. It reads `.aretino` source from a file or from stdin and writes SVG to stdout or to a file.","directories":{},"_nodeVersion":"22.22.1","dependencies":{"@aretino-chant/core":"*"},"_hasShrinkwrap":false,"optionalDependencies":{"fontkit":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/cli_0.2.0_1779979780034_0.295518621278134","host":"s3://npm-registry-packages-npm-production"}},"0.2.1":{"name":"@aretino-chant/cli","version":"0.2.1","_id":"@aretino-chant/cli@0.2.1","maintainers":[{"name":"briff","email":"fodber@organum.hu"}],"bin":{"aretino":"bin/aretino.js"},"dist":{"shasum":"4580f3ad93918d083f54fa004b41929f77e1d0d3","tarball":"https://registry.npmjs.org/@aretino-chant/cli/-/cli-0.2.1.tgz","fileCount":5,"integrity":"sha512-TbN9M7ynB6EWqcVRiT9C3cj543tttrpQ52MqNVugluA5X+yMTv671kYKBrKWy2W1XB++5IHPs5enhGn9LqiSSQ==","signatures":[{"sig":"MEUCIG9+yC/AcJbIq9cGz/nuzkgrI50PaXh8rm7FRjB18GpmAiEAoie1sS2/DHh/B1Ioyhxm/2XYmhYy4OV/05b09wOY9B0=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":17630},"type":"module","gitHead":"d0ed522bc1c3b57190a7eb53a91b1f90035e462b","scripts":{"test":"node --test"},"_npmUser":{"name":"briff","email":"fodber@organum.hu"},"_npmVersion":"10.9.4","description":"Command line renderer for Aretino chant source files. It reads `.aretino` source from a file or from stdin and writes SVG to stdout or to a file.","directories":{},"_nodeVersion":"22.22.1","dependencies":{"@aretino-chant/core":"*"},"_hasShrinkwrap":false,"optionalDependencies":{"fontkit":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/cli_0.2.1_1780239470939_0.6241027978916596","host":"s3://npm-registry-packages-npm-production"}},"0.3.0":{"name":"@aretino-chant/cli","version":"0.3.0","type":"module","bin":{"aretino":"bin/aretino.js"},"scripts":{"test":"node --test"},"dependencies":{"@aretino-chant/core":"*"},"optionalDependencies":{"fontkit":"^2.0.0"},"gitHead":"859b2ecbf0b33f81f5b6cfc08a0fe000704380be","_id":"@aretino-chant/cli@0.3.0","description":"Command line renderer for Aretino chant source files. It reads `.aretino` source from a file or from stdin and writes SVG to stdout or to a file.","_nodeVersion":"22.22.1","_npmVersion":"11.17.0","dist":{"integrity":"sha512-jYunjS32J+2mV5O7Hy33yxReg/5zPIqUoPWmNDnF7KbCTt+qZXpf6+a+BNP0hhtRMKtZGpcUTUJ0wzhycLe3gQ==","shasum":"e7cafa28c1d5ce3c837e2eedb5b7c7d5f589454c","tarball":"https://registry.npmjs.org/@aretino-chant/cli/-/cli-0.3.0.tgz","fileCount":5,"unpackedSize":17630,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIC+5Zc9QfBhFLLdXsFWqnSOHJ8Ym/Fa5qXl5U+m8MP6WAiAEu+Yo/oiEBaZeS3AFUd+kY6nICb3O6GoXPT7fRJPZTg=="}]},"_npmUser":{"name":"briff","email":"fodber@organum.hu"},"directories":{},"maintainers":[{"name":"briff","email":"fodber@organum.hu"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cli_0.3.0_1783097977356_0.24586545517705138"},"_hasShrinkwrap":false}},"time":{"created":"2026-05-28T12:48:59.997Z","modified":"2026-07-03T16:59:37.591Z","0.1.0":"2026-05-28T12:49:00.358Z","0.2.0":"2026-05-28T14:49:40.174Z","0.2.1":"2026-05-31T14:57:51.079Z","0.3.0":"2026-07-03T16:59:37.486Z"},"description":"Command line renderer for Aretino chant source files. It reads `.aretino` source from a file or from stdin and writes SVG to stdout or to a file.","maintainers":[{"name":"briff","email":"fodber@organum.hu"}],"readme":"# Aretino CLI\n\nCommand line renderer for Aretino chant source files. It reads `.aretino`\nsource from a file or from stdin and writes SVG to stdout or to a file.\n\n## Install\n\n```bash\nnpm install -g @aretino-chant/cli\n```\n\n## Use\n\n```bash\naretino input.aretino --output output.svg\ncat input.aretino | aretino --output output.svg\n```\n\n## Renderer Options\n\nThe CLI exposes `@aretino-chant/core` renderer options as command line\nparameters. Use the core option name in kebab-case:\n\n```bash\naretino input.aretino \\\n  --width-mm 180 \\\n  --staff-space-mm 1.75 \\\n  --lyric-size 10 \\\n  --text-font \"EB Garamond\" \\\n  --output output.svg\n```\n\nCommon mappings:\n\n| Core API option | CLI parameter |\n|---|---|\n| `width` | `--width` |\n| `widthMm` | `--width-mm` |\n| `dpi` | `--dpi` |\n| `staffSpaceMm` | `--staff-space-mm` |\n| `lyricSize` | `--lyric-size` |\n| `textFont` | `--text-font` |\n| `noteSpacing` | `--note-spacing` |\n| `zoom` | `--zoom` |\n| `hideRepeatClef` | `--hide-repeat-clef` |\n| `sourceMap` | `--source-map` |\n\nRenderer options can also be written in the source file with `%option:`\nheaders. Explicit command line parameters override matching source options.\n\n## Font Resolution\n\nAretino needs real text metrics to align lyrics accurately under the notation.\nSet the text font explicitly with `--text-font` so the SVG text and the\nmeasured text use the same font:\n\n```bash\naretino input.aretino \\\n  --text-font \"EB Garamond\" \\\n  --output output.svg\n```\n\nFor system fonts this works well because the CLI can resolve the requested font\nfamily for measurement, and the generated SVG keeps the `font-family` reference.\nOn Linux, system font resolution uses fontconfig. Fonts are not embedded into\nthe SVG; the SVG renderer or converter must be able to find the same font on the\nsystem where the SVG is displayed or converted.\n\nFor custom font files, pass the files used for measurement explicitly. Still set\n`--text-font` to the family name that the SVG should request:\n\n```bash\naretino input.aretino \\\n  --text-font \"EB Garamond\" \\\n  --font-file ~/fonts/EBGaramond-Regular.ttf \\\n  --font-italic ~/fonts/EBGaramond-Italic.ttf \\\n  --output output.svg\n```\n\nUse `--font-bold` and `--font-bold-italic` as static-file overrides when the\nfamily cannot derive those styles from the regular or italic font.\n\nIf the font cannot be resolved, the SVG is still generated, but lyric spacing may\nfall back to estimated metrics and can differ from the final renderer.\n\n## PDF Conversion\n\nUse `rsvg-convert` to convert the SVG to PDF:\n\n```bash\naretino input.aretino \\\n  --text-font \"EB Garamond\" \\\n  --output output.svg\n\nrsvg-convert -f pdf -o output.pdf output.svg\n```\n\n`rsvg-convert` is the recommended PDF path because it resolves and embeds the\nreferenced text fonts in the PDF while preserving the vectorised musical\nsymbols from the SVG.\n\n## License\n\n- Source code: [MPL-2.0](../../LICENSE)\n- Documentation: [CC-BY-4.0](../core/docs/LICENSE)\n","readmeFilename":"README.md"}