$ rumbas --help
Make online exercises great again!
Usage: rumbas [OPTIONS] <COMMAND>
Commands:
compile
Compile a rumbas exam (or question)
check
Check a rumbas exam (or question)
watch
Watch a path
fmt
Format a rumbas exam (or question)
import
Import a numbas .exam file
init
Initialize a rumbas project in this folder
update-repo
Update the repository to the next rumbas version
export
Export a rumbas exam as one yaml. All default files and templating is resolved
schema
Creates files with the json schemas (beta). See https://github.com/m8rex/rumbas-examples/tree/main/.vscode for usage instructions
generate-shell-completion
Generate shell completion file. Placing this file at the right location and reloading your shell, will give you shell completion for rumbas
editor-output
Generates a folder structure that can be hosted and used as an 'editor' in the numbas lti provider
help
Print this message or the help of the given subcommand(s)
Options:
-v...
Sets the level of verbosity
-v sets the level to ERROR
-vv sets the level to WARN
-vvv sets the level to INFO
-vvvv sets the level to DEBUG
The default is -vvv
-q
Enables quiet mode. Nothing is logged. This has precedence over the verbose option
-h, --help
Print help information (use `-h` for a summary)
-V, --version
Print version information
$ rumbas compile --help
Compile a rumbas exam (or question)
You can pass a path to a folder to compile all files in the folder.
Usage: compile [OPTIONS] <EXAM_OR_QUESTION_PATHS>...
Arguments:
<EXAM_OR_QUESTION_PATHS>...
The path to the exam or question file to compile.
If a folder within the questions or exams folder is used, all questions/exams in that folder will be compiled.
It is possible to specify multiple paths to folder/files.
Options:
-s, --scorm
Include the files necessary to make a SCORM package
-z, --zip
Create a zip file instead of a directory
--no-minification
Don't perform minification on the created js in the exam. Useful if you don't have uglifyjs or want to debug something
-h, --help
Print help information (use `-h` for a summary)
$ rumbas check --help
Check a rumbas exam (or question)
You can pass a path to a folder to check all files in the folder.
Usage: check <EXAM_OR_QUESTION_PATHS>...
Arguments:
<EXAM_OR_QUESTION_PATHS>...
The path to the exam or question file to check.
If a folder within the questions or exams folder is used, all questions/exams in that folder will be checked.
It is possible to specify multiple paths to folder/files.
Options:
-h, --help
Print help information (use `-h` for a summary)
$ rumbas watch --help
Watch a path
Usage: watch [OPTIONS] <PATH>
Arguments:
<PATH>
The path to watch
Options:
-o
Only check exams and questions that change due to file changes, but don't compile them with numbas
-h, --help
Print help information
$ rumbas fmt --help
Format a rumbas exam (or question).
You can pass a path to a folder to format all files in the folder.
Usage: fmt <EXAM_OR_QUESTION_PATHS>...
Arguments:
<EXAM_OR_QUESTION_PATHS>...
The path to the exam or question file to format.
If a folder within the questions or exams folder is used, all questions/exams in that folder will be formatted.
It is possible to specify multiple paths to folder/files.
Options:
-h, --help
Print help information (use `-h` for a summary)
$ rumbas import --help
Import a numbas .exam file
Resources have to be manually placed in the resources folder
Usage: import [OPTIONS] <EXAM_PATH>
Arguments:
<EXAM_PATH>
The path to the numbas .exam file
Options:
-q
Tells rumbas that this is the exam file of a numbas question instead of of a numbas exam
-h, --help
Print help information (use `-h` for a summary)
$ rumbas init --help
Initialize a rumbas project in this folder
Usage: init [OPTIONS]
Options:
--summative
Whether the defaults should be of summative nature (instead of formative)
-h, --help
Print help information
$ rumbas export --help
Export a rumbas exam as one yaml. All default files and templating is resolved.
Can be useful to debug exams / questions that don't behave as expected
Usage: export <EXAM_OR_QUESTION_PATHS>...
Arguments:
<EXAM_OR_QUESTION_PATHS>...
The path to the exams to export
If a folder within the questions or exams folder is used, all questions/exams in that folder will be exported.
It is possible to specify multiple paths to folder/files.
Options:
-h, --help
Print help information (use `-h` for a summary)
$ rumbas schema --help
Creates files with the json schemas (beta). See https://github.com/m8rex/rumbas-examples/tree/main/.vscode for usage instructions
Usage: schema
Options:
-h, --help
Print help information
$ rumbas generate-shell-completion --help
Generate shell completion file. Placing this file at the right location and reloading your shell, will give you shell completion for rumbas.
Example for bash: rumbas generate-shell-completion bash | sudo tee /usr/share/bash-completion/completions/rumbas
Usage: generate-shell-completion <SHELL>
Arguments:
<SHELL>
The shell for which the shell competion should be generated
[possible values: bash, elvish, fish, powershell, zsh]
Options:
-h, --help
Print help information (use `-h` for a summary)
$ rumbas editor-output --help
Generates a folder structure that can be hosted and used as an 'editor' in the numbas lti provider
Only exams are compiled.
Usage: editor-output <OUTPUT_PATH> <URL_PREFIX>
Arguments:
<OUTPUT_PATH>
The path to the folder where the output should be generated
<URL_PREFIX>
The url prefix for all editor api calls
Options:
-h, --help
Print help information (use `-h` for a summary)
$ rumbas help --help
Print this message or the help of the given subcommand(s)
Usage: help [COMMAND]...
Arguments:
[COMMAND]...
Print help for the subcommand(s)