runscribe 0.1.2

Turn what you just did in the terminal into a clean, re-runnable runbook — offline, no AI, your history never leaves your machine.

runscribe

Turn what you just did in the terminal into a clean, re-runnable runbook — offline, no AI, your history never leaves your machine.

Every team has tribal knowledge stuck in one person's head: how to deploy, how to restore a backup, how to rotate a key. Writing it down is tedious and it goes stale the moment the commands change. runscribe captures a real session as you work and mechanically turns it into a plain-Markdown SOP you can edit, share, and re-run.

• 🔒 100% local. No account, no network, no telemetry. Nothing is ever uploaded — not to a server, not to an LLM.
• 🤖 No AI. The runbook is produced deterministically from what actually ran. Same session in, same runbook out.
• 📝 Plain Markdown out. Hand-editable, diff-able, and readable without runscribe installed.
• 🧹 Secret-aware. Built-in redaction scrubs common tokens, keys, and credentials before they land in a shared doc.

Why not just use script/asciinema or an AI tool? Recorders give you an unsearchable replay, not an editable procedure. AI runbook generators send your shell activity to a model. runscribe gives you a clean, editable SOP and keeps everything on your machine.

Install

pip install runscribe      # the command is `runscribe`

Or grab a standalone binary (no Python required) from the Releases page — one file each for Linux, macOS, and Windows.

Use

1. Record — run your commands as normal:

runscribe record

* recording - commands run for real; # note, ## section, exit to finish.
runscribe:myproject$ ## Deploy the API
runscribe:myproject$ # Make sure you're on the release tag first
runscribe:myproject$ git checkout v1.4.2
runscribe:myproject$ ./deploy.sh staging
runscribe:myproject$ exit

2. Build — turn the session into a runbook:

runscribe build --last -o deploy.md

---
title: "Runbook — 20260706-141210"
created: "2026-07-06T14:12:10"
generated_by: runscribe
---

# Runbook — 20260706-141210

## Deploy the API

Make sure you're on the release tag first

<!-- runscribe: id=1 -->
```bash
git checkout v1.4.2

./deploy.sh staging

**3. Run** — replay a runbook step by step, later or on another machine:

```bash
runscribe run deploy.md

running 2 step(s) from deploy.md

## Deploy the API
$ git checkout v1.4.2
  run this step? [Y]es / [s]kip / [q]uit:

Each command is shown before it runs; you confirm (or --yes to run unattended). {{PLACEHOLDER}} tokens are filled in — prompted, or passed with --set NAME=value. A failing step halts the run (unless --keep-going), and on POSIX state persists across steps just like recording.

Export to HTML

Want a shareable web page instead of Markdown? Build with --format html (-f html):

runscribe build --last --format html -o deploy.html

You get a single self-contained .html file — all styling is inlined, there are no external assets, and every command is HTML-escaped — so you can open it in any browser or attach it to a ticket. Markdown (--format md) is the default.

Standalone binary (no Python needed)

Each tagged release attaches a one-file executable for Linux, macOS, and Windows to the Releases page — handy for a server or teammate without Python. It's the same CLI (record / build / run), just frozen into one file:

# Linux / macOS — mark executable once, then use it like the `runscribe` command
chmod +x runscribe-linux-x86_64
./runscribe-linux-x86_64 record
./runscribe-linux-x86_64 build --last -o deploy.md

# Windows (PowerShell)
.\runscribe-windows-x86_64.exe record

Command reference

Command	What it does	Key options
runscribe record	Capture a live session to .runscribe/sessions/. Type # note, ## section, exit.	--subprocess (per-command), --persistent (POSIX: keep cd/export), --pty (POSIX: real terminal), --out-dir
runscribe build [SESSION]	Turn a session into a runbook.	--last, -o/--out FILE, -f/--format md|html, --keep-noise, --redact-config FILE
runscribe run RUNBOOK	Replay a runbook step by step.	-s/--set NAME=VALUE, -y/--yes, --keep-going, --persistent/--subprocess

Run runscribe <command> --help for the full list.

How it works

runscribe record records each command, its working directory, exit code, timing, and (bounded) output to an append-only JSONL file under .runscribe/sessions/. On POSIX it feeds commands to a single long-lived shell, so cd, export, and shell variables persist across steps just like a real session; on Windows (or with --subprocess) it runs each command independently. For the highest fidelity on POSIX — colored output and simple interactive TUIs — record with --pty, which attaches a real pseudo-terminal. runscribe build redacts secrets, drops navigation noise (ls, pwd, …), collapses immediately-repeated commands, and renders a Markdown runbook. Command steps are tagged with <!-- runscribe: id=N --> so runscribe run re-executes exactly those runnable steps — never prose or example-output blocks.

Custom redaction rules

Drop a .runscribe/redact.toml next to your sessions to extend the built-in scrubbing:

# Extra regexes to scrub (matched spans become <REDACTED>).
patterns = ["INTERNAL-[0-9]{6}", "acme-[a-z]+-key"]

# Exact strings to always scrub (no regex needed).
literals = ["project-bluebird", "10.0.0.42"]

runscribe build picks it up automatically (or point at one with --redact-config).

Roadmap

• M1: record + build. Per-command capture, secret redaction, Markdown output. ✅
• M2: persistent-shell capture (cd/export/vars persist), user-extensible .runscribe/redact.toml, smarter noise filtering. ✅
• M3: runscribe run — step-by-step execution with confirmations, {{placeholders}}, and halt-on-failure. ✅
• M4: HTML export ✅, standalone binaries for Linux/macOS/Windows ✅, and PTY capture on POSIX (--pty) ✅. Native-Windows PTY (ConPTY) is the remaining follow-up.

Security & limits

Redaction is conservative but not a guarantee. Always skim a generated runbook before sharing it — runscribe cannot know that an unusual internal token is a secret. Recorded sessions under .runscribe/ are git-ignored by default because their output may contain sensitive data.

License

MIT © 2026 Hamza Mansoor