charmbracelet / charmbracelet/vhs

How is the output of commands handled?

Open
#643 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
20.9k
Forks
474
Avg merge
4d 1h
Merged PRs (30d)
2

Description

## Describe the bug

I recorded a quick shell session and produce a GIF from it. The resulting GIF does not have the same ouput I saw and it looks like it is trying to rerun commands and getting errors.

## Setup

I'm on MacOS using the default `zsh` (`5.9 (x86_64-apple-darwin23.0)`) in iTerm2 with tmux 3.5a.

## To Reproduce

I looked in the `tape` file that was generated and I don't see any signs of the outputs in there.

## Source Code

https://github.com/fini-net/template-repo/tree/main/docs/vhs **had** the `tape` and `gif` that I ended up with.

We gave up on waiting in https://github.com/fini-net/template-repo/pull/36 so you'll need to look at the repo before then to see the files that didn't work for me.

## Expected behavior

I thought I'd see the same output that I had when I ran the command. Maybe something like:

![animation of my dev process](https://github.com/fini-net/template-repo/raw/main/docs/dev-process.gif)

## Screenshots
Add screenshots to help explain your problem.

Image

## Additional context

I'm a newb with your tool, so sorry if I missed something in the docs.

Contributor guide

Open the contributing guide

Research direction

Start by checking the referenced docs/vhs tape and GIF, or the linked template-repo history, and compare them with the reported shell session. Confirm whether command output is recorded or commands are rerun; done means generating a GIF that matches the observed output.

Written by the indexing model from the issue text.

Assessment

Tech stack
macos, zsh
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.