Skip to content

Commit bea7f77

Browse files
committed
docs: clean up installation instructions
1 parent 586e3d6 commit bea7f77

File tree

1 file changed

+40
-26
lines changed

1 file changed

+40
-26
lines changed

README.md

Lines changed: 40 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -83,23 +83,50 @@ Use a package manager:
8383
# macOS or Linux
8484
brew install vhs
8585

86-
# macOS (via MacPorts)
87-
sudo port install vhs
88-
8986
# Arch Linux (btw)
9087
pacman -S vhs
9188

9289
# Nix
9390
nix-env -iA nixpkgs.vhs
9491

92+
# Windows using scoop
93+
scoop install vhs
94+
```
95+
96+
Or, use Docker to run VHS directly, dependencies included:
97+
98+
```sh
99+
docker run --rm -v $PWD:/vhs ghcr.io/charmbracelet/vhs <cassette>.tape
100+
```
101+
102+
Or, download it:
103+
104+
* [Packages][releases] are available in Debian and RPM formats
105+
* [Binaries][releases] are available for Linux, macOS, and Windows
106+
107+
Or, just install it with `go`:
108+
109+
```sh
110+
go install github.com/charmbracelet/vhs@latest
111+
```
112+
113+
<details>
114+
<summary>Windows, Debian, Ubuntu, Fedora, RHEL, Void Instructions</summary>
115+
116+
* Debian / Ubuntu
117+
118+
```sh
95119
# Debian/Ubuntu
96120
sudo mkdir -p /etc/apt/keyrings
97121
curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
98122
echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
99123
# Install ttyd from https://github.com/tsl0922/ttyd/releases
100-
sudo apt update && sudo apt install vhs ffmpeg
124+
sudo apt update && sudo apt install vhs ffmpeg
125+
```
126+
127+
* Fedora / RHEL
101128

102-
# Fedora/RHEL
129+
```sh
103130
echo '[charm]
104131
name=Charm
105132
baseurl=https://repo.charm.sh/yum/
@@ -108,37 +135,24 @@ gpgcheck=1
108135
gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo
109136
# Install ttyd from https://github.com/tsl0922/ttyd/releases
110137
sudo yum install vhs ffmpeg
111-
112-
# Void Linux
113-
sudo xbps-install vhs
114-
115-
# Windows using winget
116-
# Note: Winget will install all the needed dependencies, which're FFmpeg and ttyd.
117-
# No need to do any prerequisites to install vhs using this method.
118-
winget install charmbracelet.vhs
119-
120-
# Windows using scoop
121-
scoop install vhs
122-
123138
```
124139

125-
Or, use Docker to run VHS directly, dependencies included:
140+
* Void
126141

127142
```sh
128-
docker run --rm -v $PWD:/vhs ghcr.io/charmbracelet/vhs <cassette>.tape
143+
sudo xbps-install vhs
129144
```
130145

131-
Or, download it:
132-
133-
* [Packages][releases] are available in Debian and RPM formats
134-
* [Binaries][releases] are available for Linux, macOS, and Windows
135-
136-
Or, just install it with `go`:
146+
* Windows
137147

138148
```sh
139-
go install github.com/charmbracelet/vhs@latest
149+
winget install charmbracelet.vhs
150+
# or scoop
151+
scoop install vhs
140152
```
141153

154+
</details>
155+
142156
[releases]: https://github.com/charmbracelet/vhs/releases
143157

144158
## Record Tapes

0 commit comments

Comments
 (0)