CLI

This part of the documentation covers the CLI interface and is auto-generated by sphinx-click extension.

Warning

The CLI interface differs depending on the available opt-in extensions:

• Sphinx

• Toml

The documentation shown here uses all opt-in features.

Note

More information about the single configuration options can be found in the Configuration section

Note

If you get an exception and the pretty output makes the exception information unreadable try to run rstcheck with the environment variable _TYPER_STANDARD_TRACEBACK set to 1 like _TYPER_STANDARD_TRACEBACK=1 rstcheck somefile.rst`. Read more at typer’s docs.