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: 6 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 (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-04T17:19:11.000Z (17 days ago)
- Last Synced: 2024-12-08T08:01:28.599Z (13 days ago)
- Topics: ansi-colors, cli, screenshot, shell, terminal
- Language: Go
- Homepage:
- Size: 1.33 MB
- Stars: 456
- Watchers: 6
- Forks: 20
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ops - homeport/termshot - 11-10|2024-10-02 | 根据终端命令输出创建屏幕截图 | (终端命令行工具)
README
# termshot
[](https://github.com/homeport/termshot/blob/main/LICENSE)
[](https://goreportcard.com/report/github.com/homeport/termshot)
[](https://github.com/homeport/termshot/actions?query=workflow%3A%22Tests%22)
[](https://codecov.io/gh/homeport/termshot)
[](https://pkg.go.dev/github.com/homeport/termshot)
[](https://github.com/homeport/termshot/releases/latest)
Generate beautiful screenshots of your terminal, from your terminal.
```sh
termshot --show-cmd -- lolcat -f <(figlet -f big foobar)
```
This command generates this screenshot:
## Installation
To install with Homebrew on macOS or Linux:
```sh
brew install homeport/tap/termshot
```
See [Releases](https://github.com/homeport/termshot/releases/) for pre-compiled binaries for Darwin and Linux.
## Usage
This tool reads the console output and renders an output image that resembles a user interface window. It's inspired by some other web-based tools like [carbon.now.sh](https://carbon.now.sh/), and [codekeep.io/screenshot](https://codekeep.io/screenshot). Unlike those tools, `termshot` does not blindly apply syntax highlighting to some provided text; instead it reads the ANSI escape codes ("rich text") logged by most command-line tools and uses it to generate a high-fidelity "screenshot" of your terminal output.
Like `time`, `watch`, or `perf`, just prefix the command you want to screenshot with `termshot -- `.
```sh
termshot -- ls -a
```
This will generate an image file called `out.png` in the current directory.
In some cases, if your target command contains _pipes_—there may still be ambiguity, even with `--`. In these cases, wrap your command in double quotes.
```sh
termshot -- "ls -l | grep go"
```
#### `--show-cmd`/`-c`
Include the target command in the screenshot.
```sh
termshot --show-cmd -- "ls -a"
termshot --c -- "ls -a"
```
#### `--edit`/`-e`
Edit the output before generating the screenshot. This will open the rich text output in the editor configured in `$EDITOR`, using `vi` as a fallback. Use this flag to remove unwanted or sensitive output.
```sh
termshot --edit -- "ls -a"
termshot -e -- "ls -a"
```
#### `--filename`/`-f`
Specify a path where the screenshot should be generated. This can be an absolute path or a relative path; relative paths will be resolved relative to the current working directory.
```sh
termshot -- "ls -a" # defaults to /out.png
termshot --filename my-image.png -- "ls -a"
termshot --filename screenshots/my-image.png -- "ls -a"
termshot --filename /Desktop/my-image.png -- "ls -a"
```
Defaults to `out.png`.
#### `--version`/`-v`
Print the version of `termshot` installed.
```sh
$ termshot --version
termshot version 0.2.5
```
### Multiple commands
In order to work, `termshot` uses a pseudo terminal for the command to be executed. For advanced use cases, you can invoke a fully interactive shell, run several commands, and capture the entire output. The screenshot will be 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.