CLI Reference

automath

Version

Info: Installed database: /home/docs/.local/share/automathics/automath-0.3.1.db
automath, version 0.3.1

Help

Usage: automath [OPTIONS] COMMAND [ARGS]...

  Automathics exercise generator.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  render  Render objects from automathlib.
  show    Show information about automathics resources.

automath render

Usage: automath render [OPTIONS] COMMAND [ARGS]...

  Render objects from automathlib.

Options:
  --help  Show this message and exit.

Commands:
  doc  Render a document as a standalone HTML page.
  svg  Parse EXPRESSION and render it as a standalone SVG.

Note To enable autocompletion for automath render doc command in the bash shell, see installation

automath show

Usage: automath show [OPTIONS] COMMAND [ARGS]...

  Show information about automathics resources.

Options:
  --help  Show this message and exit.

Commands:
  config  Displays the loaded configuration and highlights the values...
  docs    List available document references.

automathd

automathd starts the HTTP daemon, which listens on the port defined in automathd.yaml (default: 9998). Once running, worksheets can be requested via:

http://127.0.0.1:9998/?docref=doc_ref

where doc_ref is the identifier of one of the available worksheets.