Command-line

In addition to the GitHub Action, rich-codex is also a stand-alone command line tool.

You are welcome to use it locally, for example when first writing new documentation and generating initial images to check their output.

💥⚠️ Warning ⚠️💥

Please remember that rich-codex is designed to run arbitrary commands that it finds within documentation for your project.

You alone are responsible for any damage you cause to your computer! 🙃 Running rich-codex entirely within GitHub Actions is recommended 👍🏻

Local installation

You can install rich-codex from the Python Package Index (PyPI) with pip or equivalent.

pip install rich-codex

At its simplest, the command-line tool runs without any arguments and recursively searches the current working directory for anything it recognises:

rich-codex

Behaviour can be customised with command-line flags or by setting environment variables, see rich-codex --help:

Requirements for PNG outputs

Nothing extra. PNG output is rasterised by resvg, which ships as a self-contained wheel, so pip install rich-codex is all you need on every platform. The fonts are bundled with rich-codex as well, so the images do not depend on what is installed on the machine. See embedding the terminal font for more about that.