Skip to content

Commit 6ceba23

Browse files
uniyalabhishekuniyalabhishek
committed
docs: move macos installation section to setup.md
1 parent ba375d3 commit 6ceba23

2 files changed

Lines changed: 100 additions & 99 deletions

File tree

‎docs/README.md‎

Lines changed: 0 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -46,102 +46,3 @@ It boasts a number of handy features:
4646
- inspection of blocks, transactions, results and events
4747

4848
[GitHub repository]: https://github.com/oasisprotocol/cli/releases
49-
50-
## Installing or Updating Oasis CLI on macOS
51-
52-
This guide covers the installation or update process for the Oasis CLI on
53-
macOS (compatible with Apple Silicon like M1/M2/M3). It assumes you have
54-
Terminal access and basic command-line knowledge.
55-
56-
### Prerequisites
57-
58-
- macOS (tested on Apple Silicon).
59-
- To avoid modifying system directories, we'll install the binary in a
60-
user-specific path (`~/.local/bin`). Ensure `~/.local/bin` is in your `PATH`.
61-
If not, add it by editing your shell configuration file (e.g., `~/.zshrc`
62-
for zsh):
63-
64-
```shell
65-
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
66-
source ~/.zshrc
67-
```
68-
69-
Create the directory if it doesn't exist:
70-
71-
```shell
72-
mkdir -p ~/.local/bin
73-
```
74-
75-
### Installation Steps
76-
77-
1. **Download the Binary**
78-
79-
- Visit the Oasis CLI [GitHub repository].
80-
- Download the latest macOS archive, e.g.,
81-
`oasis_cli_X.Y.Z_darwin_all.tar.gz` (replace `X.Y.Z` with the version,
82-
like `0.14.1`).
83-
84-
2. **Extract the Archive**
85-
86-
```shell
87-
cd ~/Downloads
88-
tar -xzf oasis_cli_X.Y.Z_darwin_all.tar.gz # replace with your version
89-
```
90-
91-
This creates a directory such as `oasis_cli_X.Y.Z_darwin_all`.
92-
93-
3. **Navigate to the Extracted Directory**
94-
95-
```shell
96-
cd oasis_cli_X.Y.Z_darwin_all
97-
```
98-
99-
4. **Move the Binary to the User Path**
100-
101-
```shell
102-
mv oasis ~/.local/bin/
103-
```
104-
105-
5. **Bypass macOS Gatekeeper** (if you encounter a security warning)
106-
107-
```shell
108-
xattr -d com.apple.quarantine ~/.local/bin/oasis
109-
```
110-
111-
If a dialog appears, go to **System Settings → Privacy & Security →
112-
Security** and click **Open Anyway.**
113-
6. **Verify Installation**
114-
115-
```shell
116-
oasis --version
117-
```
118-
119-
The CLI version should be displayed. If so, the Oasis CLI is installed and
120-
ready to use.
121-
122-
### Updating the Oasis CLI
123-
124-
To update the Oasis CLI to a newer version, simply overwrite the binary with
125-
the latest version. Your configurations (wallets, settings) are preserved.
126-
127-
1. **Check Current Version**
128-
129-
```shell
130-
oasis --version
131-
```
132-
133-
Compare the output with the latest version on the [GitHub repository] to
134-
see if an update is available.
135-
136-
2. **Update Process**
137-
138-
Follow the same installation steps above using the new version archive.
139-
Because you are overwriting the existing binary, no additional cleanup is
140-
required.
141-
142-
### Notes
143-
144-
- Clean-up: You can delete the downloaded `.tar.gz` file and extracted
145-
directory after installation or update.
146-
- For major version updates, review the release notes on GitHub for any
147-
breaking changes or additional steps.

‎docs/setup.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,106 @@ When running the Oasis CLI for the first time, it will generate a configuration
2929
file and populate it with the current Mainnet and Testnet networks. It will also
3030
configure all [ParaTimes supported by the Oasis Foundation][paratimes].
3131

32+
## Installing or Updating Oasis CLI on macOS
33+
34+
This guide covers the installation or update process for the Oasis CLI on
35+
macOS (compatible with Apple Silicon M1/M2/M3). It assumes you have Terminal
36+
access and basic command-line knowledge.
37+
38+
### Prerequisites
39+
40+
- macOS (tested on Apple Silicon).
41+
- To avoid modifying system directories, we’ll install the binary in a
42+
user-specific path (`~/.local/bin`). Ensure `~/.local/bin` is in your `PATH`.
43+
If not, add it by editing your shell configuration file (e.g., `~/.zshrc`
44+
for zsh):
45+
46+
```shell
47+
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
48+
source ~/.zshrc
49+
```
50+
51+
Create the directory if it doesn’t exist:
52+
53+
```shell
54+
mkdir -p ~/.local/bin
55+
```
56+
57+
### Installation Steps
58+
59+
1. **Download the Binary**
60+
61+
- Visit the Oasis CLI [cli-releases] page.
62+
- Download the latest macOS archive, e.g.,
63+
`oasis_cli_X.Y.Z_darwin_all.tar.gz` (replace `X.Y.Z` with the version,
64+
like `0.14.1`).
65+
66+
2. **Extract the Archive**
67+
68+
```shell
69+
cd ~/Downloads
70+
tar -xzf oasis_cli_X.Y.Z_darwin_all.tar.gz # replace with your version
71+
```
72+
73+
This creates a directory such as `oasis_cli_X.Y.Z_darwin_all`.
74+
75+
3. **Navigate to the Extracted Directory**
76+
77+
```shell
78+
cd oasis_cli_X.Y.Z_darwin_all
79+
```
80+
81+
4. **Move the Binary to the User Path**
82+
83+
```shell
84+
mv oasis ~/.local/bin/
85+
```
86+
87+
5. **Bypass macOS Gatekeeper** (if you encounter a security warning)
88+
89+
```shell
90+
xattr -d com.apple.quarantine ~/.local/bin/oasis
91+
```
92+
93+
If a dialog appears, go to **System Settings → Privacy & Security →
94+
Security** and click **Open Anyway**.
95+
96+
6. **Verify Installation**
97+
98+
```shell
99+
oasis --version
100+
```
101+
102+
The CLI version should be displayed. If so, the Oasis CLI is installed and
103+
ready to use.
104+
105+
### Updating the Oasis CLI
106+
107+
To update the Oasis CLI to a newer version, simply overwrite the binary with
108+
the latest version. Your configurations (wallets, settings) are preserved.
109+
110+
1. **Check Current Version**
111+
112+
```shell
113+
oasis --version
114+
```
115+
116+
Compare the output with the latest version on the [cli-releases] page to
117+
see if an update is available.
118+
119+
2. **Update Process**
120+
121+
Follow the same installation steps above using the new version archive.
122+
Because you are overwriting the existing binary, no additional cleanup is
123+
required.
124+
125+
### Notes
126+
127+
- Clean-up: You can delete the downloaded `.tar.gz` file and extracted
128+
directory after installation or update.
129+
- For major version updates, review the release notes on GitHub for any
130+
breaking changes or additional steps.
131+
32132
## Configuration
33133

34134
The configuration folder of Oasis CLI is located:

0 commit comments

Comments
 (0)