Test 3

Help › Course files

Check a file before you import it

The course checker checks a course file on a computer, before anyone imports it. It uses SchoolStack's own import check, so it finds exactly the mistakes the import would find, each with its place. It needs no server and no internet. With no mistakes, it shows a short summary (units, skills, questions, pictures, review statuses, rights) and the quality report as warnings: suggestions, like a missing hint, that don't stop the import. AI tools, such as the Course Author skill, run it after they write a file.

In a terminal, type schoolstack-course check Physics.zip (a .zip, a .json file or a course folder). You can add:

schoolstack-course pack Physics -o Physics.zip makes the zip from a folder (course.json, pictures, files) and checks it. schoolstack-course help shows all of this. For tools, the program ends with 0 when there are no mistakes (warnings are allowed), 1 when there are mistakes (or warnings, with --strict), and 2 when the file can't be read or the command is wrong.

To have the program, someone who has Rust installs it from SchoolStack's code with cargo install --path apps/course. Ready-made downloads for Windows, Mac and Linux come later.

Example: Ms Huda's tool writes Physics.zip and runs schoolstack-course check Physics.zip. The answer is "unit 2, skill 1, question 4: put * before the correct option". The tool fixes the option and checks again: no mistakes, and one warning, "Every practice question has a hint: 31 of 32".

Related: When a file has mistakes · Update a course with a file