Skip to content

Commit 64dbccc

Browse files
Merge pull request #585 from oasisprotocol/docs/setup-mac-update
docs: add oasis cli homebrew setup info
2 parents bb60720 + 7620772 commit 64dbccc

File tree

1 file changed

+47
-4
lines changed

1 file changed

+47
-4
lines changed

docs/setup.mdx

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
toc_max_heading_level: 2
3+
---
4+
15
import Tabs from '@theme/Tabs';
26
import TabItem from '@theme/TabItem';
37

@@ -15,6 +19,25 @@ follow the instructions for **your platform** below:
1519

1620
<Tabs>
1721
<TabItem value="Linux" label="Linux">
22+
### Homebrew
23+
24+
If you use [Homebrew on Linux](https://docs.brew.sh/Homebrew-on-Linux),
25+
you can install the Oasis CLI with:
26+
27+
#### Installation
28+
29+
```shell
30+
brew install oasis
31+
```
32+
33+
#### Verify
34+
35+
```shell
36+
oasis --version
37+
```
38+
39+
### Manual
40+
1841
#### Prerequisites
1942

2043
- amd64 or arm64 Linux.
@@ -44,6 +67,25 @@ follow the instructions for **your platform** below:
4467
</TabItem>
4568

4669
<TabItem value="macOS" label="macOS">
70+
### Homebrew (Recommended)
71+
72+
The recommended way to install the Oasis CLI on macOS is via
73+
[Homebrew](https://brew.sh/).
74+
75+
#### Installation
76+
77+
```shell
78+
brew install oasis
79+
```
80+
81+
#### Verify
82+
83+
```shell
84+
oasis --version
85+
```
86+
87+
### Manual
88+
4789
#### Prerequisites
4890

4991
- macOS (Apple Silicon & Intel).
@@ -102,11 +144,12 @@ follow the instructions for **your platform** below:
102144

103145
## Update
104146

105-
The Oasis CLI includes a built-in command to upgrade to the latest version.
106-
To update, run `oasis update`.
147+
If you installed Oasis CLI manually, the application includes a built-in
148+
`oasis update` command which upgrades software to the latest version.
107149

108-
This will check for a newer version on GitHub, show you the release notes,
109-
and ask for confirmation before downloading and replacing the current binary.
150+
This command will check for a newer version on GitHub, show you the
151+
release notes, and ask for confirmation before downloading and replacing
152+
the current binary.
110153

111154
## Configuration
112155

0 commit comments

Comments
 (0)