CLI Reference

To use the Tealdoc command-line interface:

tealdoc <command> [options]

You can view all available commands and options with:

tealdoc --help

Commands

• md: Generate documentation as a Markdown file.
• html: Generate documentation as an HTML file.
• dump: Print the internal documentation registry to the console for debugging.

Options

• --output <file>: Specifies the output file for the generated documentation.
• --all: Includes local definitions in the output.
• --plugin <plugins>: Plugins to load; plugin names are resolved the same way as lua requires.
• --no-warn-missing: Suppresses warnings about missing documentation for items.