shellshot 0.1.0

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

<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=WD7I8BR389)](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.

![alt text](docs/echo_example.png)

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

![alt text](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
```

#### `--filename` / `-f`


Specify a custom output filename:

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

#### `--clipboard`


Copy the screenshot directly to your clipboard:

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

### Examples


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

## Known Issues


- Shellshot uses Rust’s standard library `Command` to capture command output. This means the output might not exactly match what you would see in a real terminal.
- On **Windows**, the captured command output may have **decoding issues with accented or special characters** because `cmd.exe` does not use UTF-8 by default.
- `std::process::Command` is **not compatible with shell pipelines or redirections** (e.g., `ls | grep txt` will not work as expected). You would need to run a shell explicitly to handle these.
- Some commands that rely on interactive terminal features may not display correctly in the generated images.
- Not all ANSI codes are fully implemented, so some complex formatting, colors, or cursor movements may not render perfectly.