cli-shot

👋 Introduction

cli-shot takes automatic screenshots of interactive terminal CLIs, one PNG per screen.

cli-shot points at a CLI, asks which screens it has, opens each one, and writes a PNG per screen — no per-project script, no hand-maintained keystroke table, no window captures that go stale the moment the UI moves.

What's here

  • 🚀 Usage — the cli-shot binary, its flags, and worked examples
  • 📝 The contract — the three flags a CLI must implement to be shootable
  • ⚙️ How it works — the capture pipeline, why terminal emulation matters, and where it can't help
  • 📦 Library API — using cli-shot programmatically instead of via the binary

On this page