Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/homeport/termshot

Creates screenshots based on terminal command output
https://github.com/homeport/termshot

ansi-colors cli screenshot shell terminal

Last synced: 26 days ago
JSON representation

Creates screenshots based on terminal command output

Host: GitHub
URL: https://github.com/homeport/termshot
Owner: homeport
License: mit
Created: 2020-11-10T21:56:13.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-05-22T14:38:49.000Z (about 1 month ago)
Last Synced: 2024-05-22T15:54:48.354Z (about 1 month ago)
Topics: ansi-colors, cli, screenshot, shell, terminal
Language: Go
Homepage:
Size: 1.46 MB
Stars: 381
Watchers: 5
Forks: 17
Open Issues: 19
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-stars-eryajf - homeport/termshot - Creates screenshots based on terminal command output (Go)
awesome-ops - homeport/termshot - 11-10|2024-04-30 | 根据终端命令输出创建屏幕截图 | (终端命令行工具)

README

        # termshot

[![License](https://img.shields.io/github/license/homeport/termshot.svg)](https://github.com/homeport/termshot/blob/main/LICENSE)

[![Go Report Card](https://goreportcard.com/badge/github.com/homeport/termshot)](https://goreportcard.com/report/github.com/homeport/termshot)

[![Tests](https://github.com/homeport/termshot/workflows/Tests/badge.svg)](https://github.com/homeport/termshot/actions?query=workflow%3A%22Tests%22)

[![Codecov](https://img.shields.io/codecov/c/github/homeport/termshot/main.svg)](https://codecov.io/gh/homeport/termshot)

[![Go Reference](https://pkg.go.dev/badge/github.com/homeport/termshot.svg)](https://pkg.go.dev/github.com/homeport/termshot)

[![Release](https://img.shields.io/github/release/homeport/termshot.svg)](https://github.com/homeport/termshot/releases/latest)

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](https://carbon.now.sh/), [instaco.de](http://instaco.de/), or [codekeep.io/screenshot](https://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: ![example](.docs/images/example.png?raw=true "example screenshot")

## Installation

### macOS / Linux

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

### Binaries

The [releases](https://github.com/homeport/termshot/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.

  ```sh

  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.

  ```sh

  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.

  ```sh

  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.