// cli reference

CLI Reference

The complete command tree. Every command, its purpose, synopsis, and flags.

▋ common flags

Most session commands also accept --root and --config — sessions directory (default ~/.rekord/sessions); config file path (default ~/.rekord/rekord.yaml).

// recording

rekord start

Record an interactive terminal session in the current shell.

$ rekord start --name <id> [--timer <dur>] [--stop-key <key>] [--shell <sh>] [--cwd <dir>]

flag	description
--name	Recording name (required).
--timer	Auto-stop after a duration (e.g. 40s, 5m).
--stop-key	Hotkey to stop recording (e.g. ctrl-x); overrides config.
--shell	Shell to record (default: $SHELL).
--cwd	Working directory for the recorded shell.

rekord run

Record a single command without a long-lived session.

$ rekord run --name <id> -- <command> [args...]

flag	description
--name	Recording name (required).
--cwd	Working directory for the recorded command.

// sessions

rekord list

List recorded sessions, newest first.

$ rekord list [--root <dir>]

flag	description
--root	Sessions directory to list.

rekord replay

Replay a recorded session in the terminal with original timing.

$ rekord replay <session> [--speed <x>]

flag	description
--speed	Playback speed multiplier (default 1.0).

rekord commands

Show the commands extracted from a recorded session.

$ rekord commands <session> [--json]

flag	description
--json	Emit the extracted commands as JSON.

// exporting

rekord export

Export a recorded session to any supported format.

$ rekord export <session> [--to <fmt>] [-o <path>] [--redact]

flag	description
--to	Format: cast · json · markdown · script · gif · mp4 (default cast).
-o, --output	Write to a specific file path.
--size	mp4 size preset: 720p or 1080p (default 720p).
--redact	Redact secrets in the export.
--no-redact	Disable redaction even if enabled in config.

// handoff

rekord handoff

Generate an AI-ready context bundle from a session.

$ rekord handoff <session> [--include-git] [--include-tree] [--include-logs] [--copy]

flag	description
--include-git	Include git status and diff context.
--include-tree	Include a repository tree snapshot.
--include-logs	Include captured session logs.
--copy	Copy the context to the clipboard.

// memory

rekord remember

Store a durable project memory for later agents or sessions.

$ rekord remember <text> [--agent <name>] [--session <id>]

flag	description
--agent	Agent name to associate with the memory.
--session	Named Rekord session to link this memory to.

rekord recall

Search project memory.

$ rekord recall [query] [--agent <name>]

flag	description
--agent	Limit results to memories from one agent.

rekord resume

Print continuation context from the latest relevant project memory and snapshot.

$ rekord resume [--agent <name>] [--from-agent <name>] [--to-agent <name>] [--session <id>]

flag	description
--agent	Resume context for one agent.
--from-agent	Read context created by another agent.
--to-agent	Format handoff context for the next agent.
--session	Resume from a named Rekord session.

rekord snapshot

Capture a git-aware stopping point with changed files and full patches.

$ rekord snapshot [note] [--agent <name>] [--session <id>]

flag	description
--agent	Agent name to associate with the snapshot.
--session	Named Rekord session to link this snapshot to.

rekord memory add

Add a project memory using the full memory command namespace.

$ rekord memory add <text>

rekord memory list

List project memories.

$ rekord memory list

rekord memory search

Search project memories.

$ rekord memory search <query>

rekord memory show

Show one project memory by id.

$ rekord memory show <id>

rekord memory resolve

Mark a memory or blocker resolved.

$ rekord memory resolve <id>

// security

rekord scan

Scan a session for possible secrets before you share it.

$ rekord scan <session> [--strict]

flag	description
--strict	Exit non-zero if any secrets are found.

// tmux

rekord tmux status

Show whether the current shell is inside tmux.

$ rekord tmux status

rekord tmux capture

Capture a tmux pane's current contents as a session.

$ rekord tmux capture --pane <pane> --name <id>

flag	description
--pane	tmux pane or session target (required).
--name	Recording name (required).

rekord tmux record

Stream a tmux pane into a recording via pipe-pane.

$ rekord tmux record --pane <pane> --name <id>

flag	description
--pane	tmux pane or session target (required).
--name	Recording name (required).

rekord tmux start

Create a tmux session, record it, and attach.

$ rekord tmux start --session <name>

flag	description
--session	tmux session name (required).

// skills

rekord skills list

List available recording recipes, built-in and local.

$ rekord skills list [--skills-dir <dir>]

flag	description
--skills-dir	Local skills directory (default .rekord/skills).

rekord skills run

Run a skill recipe and record it as a session.

$ rekord skills run <skill> [--name <id>] [--skills-dir <dir>]

flag	description
--name	Recording name (defaults to the skill name).
--skills-dir	Local skills directory (default .rekord/skills).

// ai & automation

rekord mcp

Run a Model Context Protocol server over stdio so AI agents can drive terminals.

$ rekord mcp [--root <dir>] [--config <path>] [--no-redact]

flag	description
--root	Sessions directory (default ~/.rekord/sessions).
--config	Config file with redaction patterns.
--no-redact	Disable redaction of captures and logs.

rekord session start

Launch a detached, named background session reachable over a unix socket.

$ rekord session start --name <id> [--cols <n>] [--rows <n>] [--cwd <dir>] -- <command> [args...]

flag	description
--name	Session name (required).
--cols	Terminal width in columns.
--rows	Terminal height in rows.
--cwd	Working directory for the program.

rekord session send

Send text and/or named keys to a running session.

$ rekord session send --name <id> [text] [--key <key>]...

flag	description
--name	Session name (required).
--key	Named key to send (e.g. enter, ctrl-c); repeatable.

rekord session show

Print the current screen frame of a session.

$ rekord session show --name <id> [--format text|json]

flag	description
--name	Session name (required).
--format	Output format: text or json (default text).

rekord session wait

Block until a session matches text, goes idle, or exits.

$ rekord session wait --name <id> [--text <s>] [--idle <dur>] [--exit] [--timeout <dur>]

flag	description
--name	Session name (required).
--text	Wait until the screen contains this text.
--idle	Wait until output is quiet for a duration.
--exit	Wait until the process exits.
--timeout	Give up after a duration.

rekord session status

Show the state of one running session.

$ rekord session status --name <id>

flag	description
--name	Session name (required).

rekord session list

List all running detached sessions.

$ rekord session list

rekord session stop

Terminate a session and finalize its recording.

$ rekord session stop --name <id>

flag	description
--name	Session name (required).

// system

rekord config

View and edit the resolved rekord configuration.

$ rekord config [get <key> | set <key> <val> | view | path]

flag	description
get	Print a config value (recording.stopKey, privacy.redact).
set	Set a config value, creating rekord.yaml if needed.
view	Print the merged configuration.
path	Print the resolved config file path.

rekord doctor

Check for optional external tools (agg for gif, ffmpeg for mp4).

$ rekord doctor

rekord version

Print the Rekord version.

$ rekord version