Skip to content

Commit

Permalink
docs: wip
Browse files Browse the repository at this point in the history
  • Loading branch information
caarlos0 committed Nov 21, 2024
1 parent dc9ef95 commit 155f49f
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,14 +137,24 @@ So yeah, it’s great for debugging applications, and of course, learning about

Golden file for TUIs contain ANSI, which can be easily inspected with `sequin`:

```console
$ cat ./testdata/MyCuteApp.golden | sequin
```bash
cat ./testdata/MyCuteApp.golden | sequin
```

<p><img src="https://github.com/user-attachments/assets/16367a79-0ee3-40e1-95ae-adc46f411192" width="580"></p>

To generate golden files for your TUIs have a look at [`golden`][golden] and [`teatest`][teatest] from the [`/x`][x] project.

### Fake TTY - executing commands

You can also execute commands directly in sequin using a fake TTY, for instance:

```bash
sequin -- git status -sb
```

<p><img src="https://github.com/user-attachments/assets/444b8971-bd4f-41d1-abef-2c2b9f55ed88" width="450"></p>

## Pro Mode: Syntax Highlighting for Raw Sequences

One of the pain points that we find when reading raw ANSI output is
Expand Down
16 changes: 16 additions & 0 deletions tapes/faketty.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Output faketty.gif

Set Width 850
Set Height 650

Hide
Type "cd sequin"
Enter
Type "clear"
Enter
Show

Type "sequin -- git status -sb"
Sleep 350ms
Enter
Sleep 10s

0 comments on commit 155f49f

Please sign in to comment.