Markdown runbooks
Markdown runbooks are a Pro feature. In Free, @md, the md palette entry, and dropping a .md file show Markdown runbooks are available in the Pro edition. See Editions.
A runbook is often a Markdown file: a few sentences, then a command. Termorq opens that file and lets you run each code block where you read it.
Open a file
Type @md and press Enter. A file dialog asks for a .md file.
@md
@md ./docs/deploy.md
@md ~/notes/reset-cache.mdA path is read from the tab’s folder unless it is absolute or starts with ~. You can also drop a .md file on the window. Reload reads the file again. Close or Esc stops anything still running and closes it.
The document is rendered as Markdown with tables and task lists. Raw HTML in the file is skipped, so a document cannot run a script in the window. Images show their alt text. Only http and https links open, in the browser.
Which blocks run
Each fenced block is coloured for its language, in the current theme’s light or dark colours. The fence’s language decides how it runs:
| Fence | Runs with |
|---|---|
sh, bash, zsh, shell, script | The tab’s shell: bash or zsh, PowerShell, Command Prompt, or WSL |
powershell, pwsh, ps1 | pwsh. On Windows, Windows PowerShell when PowerShell 7 is missing |
python, py | python3, or python |
javascript, js | node |
typescript, ts | node --experimental-strip-types on Node 22.6 to 23.5, node from 23.6, or tsx |
csharp, cs, c# | dotnet run snippet.cs, a .NET 10 file-based app. Needs the .NET 10 SDK |
Any other language, or a fence with no language, is display-only with Copy.
```python
import platform
print("Hello from", platform.system())
```
```csharp
Console.WriteLine($"Hello from .NET {Environment.Version}");
```Run a block
The interpreters are found when the file loads. Each block’s header shows the command it will use, such as runs: python3 -u snippet.py. When the runtime is missing, the header says so instead (Python not installed, .NET 10 SDK not installed (found .NET 8)) and there is no Run.
Nothing runs when a file opens. Click Run on a block. The first run from a file asks This document runs code on your computer. Trust and run remembers that file with that content. A different file, or the same file after it changes, asks again.
The code is written to a temporary folder and run in the document’s folder. Standard output and errors stream into the box under the block, with errors in red. When it finishes, the box shows the exit code and how long it took, for example exit 0 · 1.2 s. Stop ends the process and everything it started. The temporary folder is deleted after each run.
Run all runs every runnable block in order. It skips blocks whose runtime is missing and stops at the first block that does not exit 0. Stop all ends it.