Skip to content

Commit

Permalink
docs(charmbracelet#100): show show-cmd flag demo in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlejandroSuero committed Jun 2, 2024
1 parent f12ed80 commit 37287fe
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,16 @@ freeze --execute "eza -lah"
</a>
</p>

#### Show executed command

```bash
freeze --execute "eza -h"
```

<p align="center">
<img alt="output of freeze command showing executed command, ANSI" src="./test/golden/svg/show-eza.svg" width="800" />
</p>

Freeze is also [super customizable](#customization) and ships with an [interactive TUI](#interactive-mode).

## Installation
Expand Down Expand Up @@ -95,6 +105,7 @@ Screenshots can be customized with `--flags` or [Configuration](#configuration)
- [`-b`](#background), [`--background`](#background): Apply a background fill.
- [`-c`](#configuration), [`--config`](#configuration): Base configuration file or template.
- [`-s`](#show-executed-command), [`--show-cmd`](#show-executed-command): Show executed command.
- [`-l`](#language), [`--language`](#language): Language to apply to code
- [`-m`](#margin), [`--margin`](#margin): Apply margin to the window.
- [`-o`](#output), [`--output`](#output): Output location for .svg, .png, .jpg.
Expand Down
15 changes: 15 additions & 0 deletions test/golden/svg/show-eza.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 37287fe

Please sign in to comment.