CLI-taken¶
Deze pagina helpt kiezen welk commando bij welke taak hoort. Voor de volledige syntax, alle argumenten/opties en foutgevallen per commando: zie de man-pagina's onder CLI-referentie.
Commando kiezen¶
| Taak | Commando |
|---|---|
| Versie tonen | vsa --version |
| VSA-notatie controleren | vsa validate <bestand-of-map> |
| AST bekijken | vsa parse <bestand.vsa> --ast |
| VSA-blokken in Markdown vinden | vsa blocks <bestand.md> |
| Eén SVG maken | vsa svg <input.vsa> <output.svg> |
| Markdownbestanden verwerken naar SVG | vsa process <input> <output> |
| Hugo-output genereren | vsa build-markdown … |
| Markdown + VSA naar A4-PDF | vsa pdf <bestand.md> |
zoek=-includes oplossen naar catalogus |
vsa resolve-catalogus <bestand.md> |
| Lettergreepstreepjes (bestand of map) | vsa syllabify <pad> |
| Platte gezongen tekst (zoekindex) | vsa text <pad> (.vsa / .mvsa / MusicXML / .mscz) |
| MusicXML exporteren | vsa musicxml <input.vsa> <output.mxl> |
| mvsa valideren (draft) | vsa mvsa validate <pad> |
| mvsa → SATB MusicXML (draft) | vsa mvsa mxl <pad> [-o …] [--section …] |
| mvsa → Coria met hulptekst-keuze | vsa mvsa mxl … --hulptekst-as-parts + @taal |
| mvsa → blad met tweede tekstregel | vsa mvsa mscz … --hulptekst |
| mvsa → MuseScore / print-PDF (draft) | vsa mvsa mscz / pdf |
| mvsa → preview-audio (draft) | vsa mvsa mp3/ogg/wav (of top-level vsa audio) |
MusicXML / MuseScore → .mvsa (werkbank-import) |
vsa mvsa import / mxl import / mscz import |
| Import + ankers (navigatie / foutzoeken) | vsa mvsa import … (default ag-vsa) daarna validate |
.mvsa leren schrijven |
mvsa schrijven 101 |
Exitcodes¶
| Exitcode | Betekenis |
|---|---|
0 |
commando succesvol |
1 |
fout gevonden of commando mislukt |
Controle in CMD:
echo %ERRORLEVEL%
Veelgebruikte voorbeelden¶
vsa validate examples\minimal\001_plain_text.vsa
vsa blocks examples\minimal\031_markdown_block_metadata.md --json
vsa musicxml mijn-lied.vsa mijn-lied.mxl
vsa text mijn-lied.mscz.mxl -o generated\mijn-lied.mscz.lyrics.txt
Platte tekst uit een canonieke .vsa / .mvsa hoort als veld zoektekst in
de YAML-frontmatter van dat bestand (editorzoeken) — zie
zoektekst.
cd /d C:\Git\orthodox-ronl\VSA-tooling
vsa zoektekst examples\mvsa\alleluia-toon-1.mvsa
vsa zoektekst examples\mvsa --check
vsa text -o …lyrics.txt blijft nuttig voor export uit .mscz / .mxl of
site-build; een sibling .lyrics.txt is niet verplicht naast de canonieke bron.
cd /d C:\Git\orthodox-ronl\VSA-tooling
vsa mvsa import generated\alleluia.mxl -o generated\alleluia.import.mvsa
vsa mvsa validate generated\alleluia.import.mvsa
Bronnen¶
Gebaseerd op:
docs/guides/user-guide.mddocs/reference/cli/index.md(en de losse man-pagina's per subcommando)docs/guides/svg-export.mddocs/guides/musicxml-export.md