Opening Runbooks

Runbooks can be opened by launching the desktop app or via the command line.

See the opening a runbook reference for the full list of flags and supported URL formats.

Opening a Runbook

There are two ways to open a runbook:

Double-click a .mdx file in Finder (macOS file association opens it in the Runbooks desktop app).
Use the command line to open a runbook from a local path or remote URL:

# Local
runbooks open ./runbooks/deploy-rds

# Remote (GitHub URL)
runbooks open https://github.com/org/repo/tree/main/runbooks/deploy-rds

For remote sources, Runbooks downloads just the runbook directory via sparse git clone and opens it in the desktop app.