Skip to content

Commit b9aff7e

Browse files
uniyalabhishekuniyalabhishek
committed
feat: add different platfrom Instructions tabs
1 parent 03194d8 commit b9aff7e

2 files changed

Lines changed: 101 additions & 112 deletions

File tree

‎docs/README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ description: Powerful CLI for managing Oasis networks, nodes, tokens and dApps
66
# Oasis Command Line Interface
77

88
Oasis command-line interface (CLI) is a powerful all-in-one tool for
9-
interacting with the Oasis Network. You can download the latest release
9+
interacting with the Oasis Network.
10+
Head to the **[installation instructions]** to download and install it!
11+
12+
[installation instructions]: setup.md
1013
binaries from the [GitHub repository] (see the [Installing or Updating Oasis
1114
CLI on macOS](setup.md#installing-or-updating-oasis-cli-on-macos) for macOS.
1215

‎docs/setup.md‎

Lines changed: 97 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,110 @@
11
# Setup
2+
<!-- markdownlint-disable MD013 MD033 MD046 -->
23

34
## Download and Run
45

56
Download the latest release from our [GitHub repository][cli-releases] and
6-
extract it to your favorite application folder.
7+
follow the instructions for **your platform** below:
8+
9+
import Tabs from '@theme/Tabs';
10+
import TabItem from '@theme/TabItem';
11+
12+
<Tabs>
13+
<TabItem value="MacOS" label="macOS">
14+
### Prerequisites
15+
16+
* macOS (Apple Silicon & Intel).
17+
* Ensure `~/.local/bin` is on your `PATH` (add it in `~/.zshrc` or `~/.bashrc`):
18+
```shell
19+
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
20+
source ~/.zshrc
21+
mkdir -p ~/.local/bin
22+
```
23+
24+
### Installation
25+
26+
1. Download the latest **macOS** archive (e.g. `oasis_cli_X.Y.Z_darwin_all.tar.gz`) from the releases page.
27+
2. Extract it:
28+
```shell
29+
cd ~/Downloads
30+
tar -xzf oasis_cli_X.Y.Z_darwin_all.tar.gz # adjust version
31+
```
32+
3. Move the binary to your path:
33+
```shell
34+
mv oasis ~/.local/bin/
35+
```
36+
4. Bypass Gatekeeper (first run only):
37+
```shell
38+
xattr -d com.apple.quarantine ~/.local/bin/oasis
39+
```
40+
If a dialog appears, open **System Settings → Privacy & Security** and click **Open Anyway**.
41+
5. Verify:
42+
```shell
43+
oasis --version
44+
```
45+
</TabItem>
46+
47+
<TabItem value="Linux" label="Linux">
48+
### Prerequisites
49+
50+
* x86-64 Linux.
51+
* Ensure `~/.local/bin` is on your `PATH`:
52+
```shell
53+
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
54+
source ~/.bashrc
55+
mkdir -p ~/.local/bin
56+
```
57+
58+
### Installation
59+
60+
1. Download the latest **Linux** archive (e.g. `oasis_cli_X.Y.Z_linux_amd64.tar.gz`).
61+
2. Extract it:
62+
```shell
63+
cd ~/Downloads
64+
tar -xzf oasis_cli_X.Y.Z_linux_amd64.tar.gz # adjust version
65+
```
66+
3. Move the binary to your path:
67+
```shell
68+
mv oasis ~/.local/bin/
69+
```
70+
4. Verify:
71+
```shell
72+
oasis --version
73+
```
74+
</TabItem>
75+
76+
<TabItem value="Windows" label="Windows">
77+
### Prerequisites
78+
79+
* Windows 10/11 (x86-64).
80+
* Decide on a folder already in your `PATH` (e.g. `%USERPROFILE%\bin`) or add one.
81+
82+
### Installation
83+
84+
1. Download the latest **Windows** ZIP file (e.g. `oasis_cli_X.Y.Z_windows_amd64.zip`).
85+
2. Extract it (double-click or `tar -xf` in PowerShell).
86+
3. Copy `oasis.exe` to a directory on your `PATH`, for example:
87+
```powershell
88+
New-Item -ItemType Directory -Force "$env:USERPROFILE\bin"
89+
Copy-Item .\oasis.exe "$env:USERPROFILE\bin\"
90+
```
91+
If that folder isn’t on the `PATH`, add it via **System Properties → Environment Variables**.
92+
4. Verify:
93+
```powershell
94+
oasis --version
95+
```
96+
</TabItem>
97+
</Tabs>
798

899
:::info
9-
10-
Oasis is currently providing official amd64 for Linux and ARM builds for MacOS.
11-
If you want to run it on another platform, you will have to
12-
[build it from source][cli-source].
13-
100+
Oasis currently provides official `amd64` builds for Linux and ARM builds
101+
for macOS. If you need another platform, you can still
102+
[build the CLI from source][cli-source].
14103
:::
15104

16105
:::info
17-
18-
We suggest that you update your system path to include a directory containing
19-
the `oasis` binary or create a symbolic link to `oasis` in your
20-
system path, so you can access it globally.
21-
106+
For convenience, add the folder containing `oasis`/`oasis.exe` to your
107+
system `PATH` or create a symlink, so you can invoke the CLI globally.
22108
:::
23109

24110
Run the Oasis CLI by typing `oasis`.
@@ -29,106 +115,6 @@ When running the Oasis CLI for the first time, it will generate a configuration
29115
file and populate it with the current Mainnet and Testnet networks. It will also
30116
configure all [ParaTimes supported by the Oasis Foundation][paratimes].
31117

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-
132118
## Configuration
133119

134120
The configuration folder of Oasis CLI is located:

0 commit comments

Comments
 (0)