-
Notifications
You must be signed in to change notification settings - Fork 22
docs: Add setup documentation for Oasis CLI for all platforms #541
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
uniyalabhishek
merged 1 commit into
master
from
uniyalabhishek/537-improve-oasis-cli-doc-mac
Jul 22, 2025
+158
−86
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| # Setup | ||
|
|
||
| ## Download and Run | ||
|
|
||
| The Oasis team provides CLI binaries for Linux, | ||
| macOS and Windows operating systems. | ||
| If you want to run it on another platform, | ||
| you can [build the CLI from source][cli-source]. | ||
|
|
||
| Download the latest release from our [GitHub repository][cli-releases] and | ||
| follow the instructions for **your platform** below: | ||
|
|
||
| <Tabs> | ||
| <TabItem value="Linux" label="Linux"> | ||
| #### Prerequisites | ||
|
|
||
| - amd64 or arm64 Linux. | ||
| - Ensure `~/.local/bin` is on your `PATH`: | ||
| ```shell | ||
| echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc | ||
| source ~/.bashrc | ||
| mkdir -p ~/.local/bin | ||
| ``` | ||
|
|
||
| #### Installation | ||
|
|
||
| 1. Download the latest **Linux** archive (e.g. `oasis_cli_X.Y.Z_linux_amd64.tar.gz`). | ||
| 2. Extract it: | ||
| ```shell | ||
| cd ~/Downloads | ||
| tar -xzf oasis_cli_X.Y.Z_linux_amd64.tar.gz # adjust version and architecture | ||
| ``` | ||
| 3. Move the binary to your path: | ||
| ```shell | ||
| mv oasis ~/.local/bin/ | ||
| ``` | ||
| 4. Verify: | ||
| ```shell | ||
| oasis --version | ||
| ``` | ||
| </TabItem> | ||
|
|
||
| <TabItem value="macOS" label="macOS"> | ||
| #### Prerequisites | ||
|
|
||
| - macOS (Apple Silicon & Intel). | ||
| - Ensure `~/.local/bin` is on your `PATH` (add it in `~/.zshrc` or `~/.bashrc`): | ||
| ```shell | ||
| echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc | ||
| source ~/.zshrc | ||
| mkdir -p ~/.local/bin | ||
| ``` | ||
|
|
||
| #### Installation | ||
|
|
||
| 1. Download the latest **macOS** archive (e.g. `oasis_cli_X.Y.Z_darwin_all.tar.gz`) from the releases page. | ||
| 2. Extract it: | ||
| ```shell | ||
| cd ~/Downloads | ||
| tar -xzf oasis_cli_X.Y.Z_darwin_all.tar.gz # adjust version | ||
| ``` | ||
| 3. Move the binary to your path: | ||
| ```shell | ||
| mv oasis ~/.local/bin/ | ||
| ``` | ||
| 4. Bypass Gatekeeper (first run only): | ||
| ```shell | ||
| xattr -d com.apple.quarantine ~/.local/bin/oasis | ||
| ``` | ||
| If a dialog appears, open **System Settings → Privacy & Security** and click **Open Anyway**. | ||
| 5. Verify: | ||
| ```shell | ||
| oasis --version | ||
| ``` | ||
| </TabItem> | ||
|
|
||
| <TabItem value="Windows" label="Windows"> | ||
| #### Prerequisites | ||
|
|
||
| - Windows 10/11 (x86-64). | ||
| - Decide on a folder already in your `PATH` (e.g. `%USERPROFILE%\bin`) or add one. | ||
|
|
||
| #### Installation | ||
|
|
||
| 1. Download the latest **Windows** ZIP file (e.g. `oasis_cli_X.Y.Z_windows_amd64.zip`). | ||
| 2. Extract it (double-click or `tar -xf` in PowerShell). | ||
| 3. Copy `oasis.exe` to a directory on your `PATH`, for example: | ||
| ```powershell | ||
| New-Item -ItemType Directory -Force "$env:USERPROFILE\bin" | ||
| Copy-Item .\oasis.exe "$env:USERPROFILE\bin\" | ||
| ``` | ||
| If that folder isn’t on the `PATH`, add it via **System Properties → Environment Variables**. | ||
| 4. Verify: | ||
| ```powershell | ||
| oasis --version | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| When running the Oasis CLI for the first time, it will generate a configuration | ||
| file and populate it with the current Mainnet and Testnet networks. It will also | ||
| configure all [ParaTimes supported by the Oasis Foundation][paratimes]. | ||
|
|
||
| ## Configuration | ||
|
|
||
| The configuration folder of Oasis CLI is located: | ||
|
|
||
| - on Linux: | ||
| - `$HOME/.config/oasis/` | ||
| - on macOS: | ||
| - `/Users/$USER/Library/Application Support/oasis/` | ||
| - on Windows: | ||
| - `%USERPROFILE%\AppData\Local\oasis\` | ||
|
|
||
| There, you will find `cli.toml` which contains the configuration of the | ||
| networks, ParaTimes and your wallet. Additionally, each file-based account in | ||
| your wallet will have a separate, password-encrypted JSON file in the same | ||
| folder named after the name of the account with the `.wallet` extension. | ||
|
|
||
| ## Multiple Profiles | ||
|
|
||
| You can utilize multiple profiles of your Oasis CLI by | ||
| passing the `--config` parameter | ||
| with a location of a desired `cli.toml`: | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ## Back Up Your Wallet | ||
|
|
||
| To back up your complete Oasis CLI configuration including your wallet, archive | ||
| the configuration folder containing `cli.toml` and `.wallet` files. | ||
|
|
||
| [cli-releases]: https://github.com/oasisprotocol/cli/releases | ||
| [cli-source]: https://github.com/oasisprotocol/cli | ||
| [paratimes]: https://github.com/oasisprotocol/docs/blob/main/docs/build/tools/other-paratimes/README.mdx | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.