Opening Runbooks

See the open command reference for the full list of flags and supported URL formats.

Ways to open a runbook

1. Double-click a .mdx file. The desktop app registers the .mdx file association on macOS and Windows.
2. Paste a local path or remote URL into Open from URL in the desktop app.
3. Use the command line:

# Local
runbooks open ./runbooks/deploy-rds

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

# Remote (git source in go-getter syntax, as in a Terragrunt source)
runbooks open github.com/org/repo//runbooks/deploy-rds?ref=v1.0

For remote sources, Runbooks clones the repository that holds the runbook and opens the runbook in the desktop app. The whole repository is cloned, so a runbook can use files outside its own directory.