rekord
Search⌘K
★ 1
// getting started

Getting Started

Install Rekord, capture your first session, and learn the handful of commands that cover 90% of day-to-day use.

Install

Rekord ships as a single static Go binary. Install it with Homebrew or go install, or grab a prebuilt archive from the Releases page.

$ brew tap Omotolani98/rekord   # macOS / Linuxbrew
$ brew install rekord
$ go install github.com/Omotolani98/rekord/cmd/rekord@latest  # from source

Every install also ships rk — a drop-in short alias for rekord (rk start …, rk version). Confirm it's on your PATH:

$ rekord version
rekord v0.1.1

Your first recording

  1. Start a session

    Drop into a recorded shell. Everything you type — and everything that prints back — is captured.

    $ rekord start --name monocron-demo
● recording session "monocron-demo" · press Ctrl-] to stop

  2. Do your work

    Run commands as you normally would. Rekord records the command, its output, exit code and timing.

    $ go test ./...
ok  github.com/monocron/app  0.231s

  3. Stop the session

    Press the stop hotkey — Ctrl-] by default — to end the recording. Rekord flushes the session to disk and prints a quick summary. (Use --timer 5m at start for hands-free auto-stop.)

    ^]
✓ saved "monocron-demo" · 5 commands · 12.4s

  4. Export it

    Turn the session into whatever you need. Markdown for docs, a cast for replay, a bundle for your agent.

    $ rekord export monocron-demo --to markdown
✓ wrote demo.md · 5 commands · 42 lines
▋ tip

Prefer one-shots? rekord run "go build ./..." records a single command without starting a long-lived session.

The commands you'll actually use

Most workflows live inside these. The CLI Reference documents every flag.

$ rekord start --name demo              # begin recording
$ rekord run --name demo -- make build  # record one command
$ rekord list                         # see your sessions
$ rekord replay demo                  # watch it back
$ rekord export demo --to gif          # share it
$ rekord handoff demo --include-git     # bundle for AI
▋ security

Before sharing anything, run rekord scan. Rekord redacts common secret shapes by default, but a scan is your last line of defense — see Redaction & Security.

Next steps

  • Recording — timer mode, single commands, and recording etiquette.
  • Exporting — every output format and when to reach for it.
  • AI Handoff — build context bundles your agent can use.