Skip to main content

tmux2html captures full tmux windows or individual panes then parses their contents into HTML.

Project description

tmux2html captures full tmux windows or individual panes then parses their contents into HTML in living ![color](https://cloud.githubusercontent.com/assets/111942/14111051/2aa0927e-f597-11e5-85d8-e529c803ec61.png). The output can either be still snapshots, or animated sequences.

With a web server that uses gzip compression, the size over the network is negligible for reasonably sized windows or panes.

Examples

Some of these may be large in dimensions. You’ll need to zoom out if you want to see all panes at once.

If you decide to look at the telnet animations yourself and don’t know how to exit, use Ctrl-] then type quit. For the Star Wars animation, press Ctrl-]<enter> to get the prompt.

Rationale

This was a weekend project I made for fun and I have no particular use for it beyond annoying my friends about how bad they should feel for not using tmux. I also thought it would be neat to have a render of my sessions that didn’t result in an image using some crummy font on a headless server.

I suppose you can use cron to capture screens and display it on your website, or use it to create terminal snippets for your blog. You could also load a pane render in elinks within your coworker’s session. The only limit is your imagination, my friend. :sparkles:

Requirements

  • tmux 1.8

  • Python 2.7 or 3.4 (could be wrong since it’s not tested in lower versions)

Installation

`shell pip install tmux2html `

Usage

`shell tmux2html 4 -o window_5_in_current_session.html tmux2html .0 -o first_pane_in_current_window.html tmux2html other:1.2 -o second_window_third_pane_in_other_session.html `

Switch | Description —— | ———– target (positional) | Target window or pane. Uses tmux’s target syntax, but always 0-indexed. (e.g. sess:1.2 - Session: sess, Window 2, Pane 3. Default target is window.) -o / –output | Output file. Prints to stdout if omitted. –light | Light background. –interval | Number of seconds between captures. –duration | Number of seconds to capture. 0 for indefinite recording, -1 to disable. –fg | Foreground color. Can be a color index or R,G,B –bg | Background color. Can be a color index or R,G,B

Limitations

  • The cursor is not displayed.

  • Basic colors will not match your terminal’s configured colors.

  • Animations aren’t perfect with a lot of splits and fast resizing.

  • Animations won’t capture scrolling the pane’s history (selection mode).

  • In animations, a pane is updated with the full pane’s content.

  • Zoomed panes will ruin all the fun.

  • Your imagination :stars:

Notes

Still captures are plain HTML and CSS. Animations uses Javascript. To keep the size reasonable with animations, [pako](https://github.com/nodeca/pako) is used to inflate the gzipped frame contents. Combined with decompression of frame content, the animations will use a fair amount of CPU. So, you shouldn’t run animations indefinitely on your low performance or battery operated fun machines.

To Do

  • If there’s practical use for animations in the future, only lines that are different should be updated to keep the size low.

License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tmux2html-0.1.tar.gz (20.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page