termshot

README

termshot

Terminal screenshot tool, which takes the console output and renders an output image that resembles a user interface window. The idea is similar to what carbon.now.sh, instaco.de, or codekeep.io/screenshot do. Instead of applying syntax highlight based on a programming language, termshot is using the ANSI escape codes of the program output. The result is clean screenshot (or recreation) of your terminal output. If you want, it has an option to edit the program output before creating the screenshot. This way you can remove unwanted sensitive content. Like time, watch, or perf, just place termshot before the command and you are set.

For example, termshot --show-cmd -- lolcat -f <(figlet -f big foobar) will create a screenshot which looks like this:

Installation

macOS

Use homebrew to install termshot: brew install homeport/tap/termshot

Binaries

The releases section has pre-compiled binaries for Darwin, and Linux.

Notes

• Since both termshot and your command can have command line flags, it is recommended to use -- to separate them.

  termshot --edit -- tool --apply --force
  

• If you want to run a command and pipe the output into another, you have to use quotes to make this clear on the command line.

  termshot --show-cmd -- "figlet foobar | lolcat"
  

• In order to work, termshot uses a pseudo terminal for the command to be executed. This means you can invoke a fully interactive shell and capture the entire output. The screenshot is created once you terminate the shell.

  termshot /bin/zsh
  

• Please note: This project is work in progress. Although a lot of the ANSI sequences can be parsed, there are definitely commands in existence that create output that cannot be parsed correctly, yet. Also, commands that reset the cursor position are known to create issues.