Skip to content

Commit 4505dc2

Browse files
authored
Document Homebrew formula to Cask migration (#397)
Update Mac installation instructions to use Cask and add migration guide for existing formula users. Addresses #390 by documenting the upgrade path from deprecated formula to Cask version.
1 parent 57f2367 commit 4505dc2

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,23 @@ This is a [blog post](https://owenou.com/upterm) to describe Upterm in depth.
1515
### Mac
1616

1717
```console
18-
brew install owenthereal/upterm/upterm
18+
brew install --cask owenthereal/upterm/upterm
1919
```
2020

21+
#### Migrating from Formula to Cask
22+
23+
If you previously installed upterm using the Homebrew formula (without `--cask`), you'll need to migrate to the Cask version:
24+
25+
```console
26+
# Uninstall the old formula version
27+
brew uninstall upterm
28+
29+
# Install the new Cask version
30+
brew install --cask owenthereal/upterm/upterm
31+
```
32+
33+
**Note:** Running `brew upgrade` with the old formula installed will fail with an error. Follow the migration steps above to resolve this.
34+
2135
### Standalone
2236

2337
`upterm` can be easily installed as an executable. Download the latest [compiled binaries](https://github.com/owenthereal/upterm/releases) and put it in your executable path.

0 commit comments

Comments
 (0)