Getting started

Installation

Shell (Mac, Linux):

curl -fsSL https://raw.githubusercontent.com/DudeBro249/docrunner/stable/installers/install.sh | sh

PowerShell (Windows):

iwr -useb https://raw.githubusercontent.com/DudeBro249/docrunner/stable/installers/install.ps1 | iex

If none of these methods work, you can also install the docrunner binary from the releases. Make sure to add it to PATH so you can access it from anywhere

QuickStart

docrunner --help

Python Example

docrunner run --language python --markdown-path README.md --multi-file

• This command executes all python within README.md and does so by putting each snippet of python into a separate file, and running each file. If you don't want each snippet in a separate python file, just remove the --multi-file option.

Updating

Updating docrunner is as simple as calling:

docrunner self update

This will provide you with simple instructions on how to update docrunner