shellshot 0.2.1

Transform your command-line output into clean, shareable images with a single command.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

<div align="center">

<h1>Shellshot</h1>

[![Crates.io](https://img.shields.io/crates/v/shellshot)](https://crates.io/crates/shellshot)
[![Build Status](https://img.shields.io/github/actions/workflow/status/lhenry-dev/shellshot/ci.yml?branch=main)](https://github.com/lhenry-dev/shellshot/actions/workflows/ci.yml?branch=main)
[![Dependency Status](https://deps.rs/repo/github/lhenry-dev/shellshot/status.svg)](https://deps.rs/repo/github/lhenry-dev/shellshot)
[![Documentation](https://docs.rs/shellshot/badge.svg)](https://docs.rs/shellshot)
[![License](https://img.shields.io/crates/l/shellshot)](https://crates.io/crates/shellshot)
[![MSRV](https://img.shields.io/badge/MSRV-1.85.1-dea584.svg?logo=rust)](https://github.com/rust-lang/rust/releases/tag/1.85.1)
[![codecov](https://codecov.io/gh/lhenry-dev/shellshot/graph/badge.svg?token=UA9AAN26IO)](https://codecov.io/gh/lhenry-dev/shellshot)

---

**Transform your command-line output into clean, shareable images with a single command.**

</div>

`Shellshot` is a fast, cross-platform tool written in Rust that captures terminal sessions and transforms them into polished screenshots. Perfect for documentation, presentations, social media, or showcasing terminal workflows.

## Features


- **Beautiful Rendering**: High-quality image generation with customizable window decorations
- **ANSI Support**: Correctly renders ANSI colors, styles, and formatting.
- **Clipboard Integration**: Copy screenshots directly to your clipboard with one flag
- **Command Execution**: Execute commands and capture their output automatically
- **Customizable**: Adjust window decorations, colors, padding, and output filename.
- **Cross-Platform**: Works on Windows and Linux

## Installation


```bash
cargo install shellshot
```

## Usage Examples


### Basic Usage


```bash
shellshot echo "Hello from ShellShot!"
```

This will execute the command, capture its output, and generate an image file named `out.png` in the current directory.

![echo example](docs/echo_example.png)

```bash
shellshot ping -c 5 localhost
```

![ping example](docs/ping_example.png)

### Command Options


#### `--no-decoration`


Remove window decorations (title bar and control buttons):

```bash
shellshot --no-decoration echo "Hello, World!"
```

#### `--decoration <style>` / `-d`


Specify the decoration style (default: `classic`):

```bash
shellshot --decoration classic ls -la
```

#### `--output` / `-o`


Specify a custom output filename:

```bash
shellshot --outpout my-screenshot.png cargo build
shellshot --output screenshots/build.png cargo test
```

#### `--clipboard`


Copy the screenshot directly to your clipboard:

```bash
shellshot --clipboard git status
```

#### `--width` / `-W` et `--height` / `-H`


Specify the final image dimensions in pixels or 'auto' (default: auto):

```bash
shellshot --width 800 --height 600 echo "Hello, world!"
```

#### `--timeout` / `-t`


Set a timeout in seconds for command execution (0 = no timeout):

```bash
shellshot --timeout 5 ping -c 10 localhost
```

### Examples


```bash
shellshot echo "Hello, Shellshot!"
shellshot --decoration classic ls --color=always
shellshot --output docs/example.png cargo --version
shellshot --clipboard git log --oneline -5
shellshot --no-decoration python --version
```