Skip to content

bitplane/tvmux

Repository files navigation

📺 tvmux

Per-project/window tmux recorder using asciinema; records the current pane and follows the user around the current window.

🎥 Usage

Install tvmux from pip or uv, or run standalone from uvx, like so:

$ uvx tvmux

The above will open a textual user interface, where you can view ongoing recordings, start + stop them etc.

You can start recording from the command line too:

# Start recording
tvmux rec
# list ongoing recordings
tvmux rec ls
# stop them all, like you would a Docker container
tvmux rec stop $(tvmux ls -q)

By default, it'll save to ~/Videos/tmux/YYYY-MM/. See all configuration options:

# Show default config (TOML format)
tvmux config defaults

# Show available environment variables
tvmux config defaults --format=env

# Show your current config
tvmux config show

To customize, create ~/.tvmux.conf or use environment variables like TVMUX_OUTPUT_DIRECTORY.

🔗 links

🌍 See also

📺 asciinema The terminal recorder
🪟 textual TUI library for Python
🗔 bittty My terminal
🎬 sh2mp4 Convert this to MP4 files

TODO

Prep for 0.6

  • Need asciinema scrubber using bittty (wip)
  • Start a basic TUI in Textual

About

A tmux session recorder using asciinema

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •