Skip to content

Latest commit

 

History

History
8 lines (5 loc) · 1.99 KB

cli.md

File metadata and controls

8 lines (5 loc) · 1.99 KB

More commands and settings

English | 日本語

Details of the egatari command that follow "With npm (no clone)" in the README.

npx egatari --help lists the other commands (ids, ids-of, sheet, comment-shots, portable, video, tts). npx egatari ids-of <file.ega.html> […] prints, one line per file (tab-separated; --json for JSON), the docId, the sourceSha256 recomputed from the file's source (the version of the source: it leaves out audio and built parts; a warning on stderr if it differs from the value written in the file) and the SHA-256 of the whole file (identifies the file itself, for checking at distribution or LMS upload). Who released it is a matter for signatures (format §10, not implemented yet). npx egatari video <working folder | .ega.html> builds and exports an Egatari file with its existing audio to video (needs ffmpeg). Relative paths are resolved from the current folder. The package carries the default fonts the build embeds (no get-fonts) and the fonts of the bundled themes (Zen Maru Gothic of asagi, Fraunces of bengara), so every bundled theme works from npx egatari alone. The other optional fonts, which only the slides' own CSS or theme can name (such as Klee One), are in the separate package @egatari/fonts-extra (npm i -D @egatari/fonts-extra, or npx -p egatari -p @egatari/fonts-extra egatari …; egatari build and check say so when a file needs it). Of each vendored part, the package carries the index.js the build reads and its licence (not its README, demo or changelog; egatari doctor checks every index.js against components.lock.json and the manifests' per-file sha256). The default TTS voices are downloaded on the first egatari tts (see Requirements in the README). egatari tts runs tts/synth.py with uv and keeps its Python environment in your cache folder (set UV_PROJECT_ENVIRONMENT to put it elsewhere).