@openexam/cli
v0.1.0
Published
Command-line interface for OpenExam: new / validate / render / preview (spec 0.1).
Readme
@openexam/cli
Command-line interface for OpenExam, targeting spec 0.1 (M1).
The package that wires the spec implementation, the standard mc
addon, and both renderers into a real workflow:
openexam new my-quiz
cd my-quiz
openexam validate
openexam render --target=html --out preview.html
openexam render --target=pdf --out exam.pdf # needs system latexmk
openexam preview # local web serverSubcommands
| Command | What it does |
|------------------------------------------|--------------------------------------------------------------|
| openexam new <name> | Scaffold an assignment package with one MC question. |
| openexam validate [path] | Parse + schema-check every assignment under the path. |
| openexam render --target=html [path] | Emit an HTML preview document. |
| openexam render --target=pdf [path] | Compile to PDF via system latexmk. |
| openexam preview [path] | Serve the HTML preview locally on a port. |
For all commands [path] defaults to the current directory. Output
goes to stdout unless --out <file> is specified.
Prerequisites
- Node ≥ 20.10 (per workspace root).
- For
render --target=pdf: a TeX Live install withlatexmkonPATH. See../../docs/dev/setup.md§"M1 — LaTeX rendering".
License
Apache-2.0. See LICENSE and the repository root
../../LICENSE.
