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.
Download the latest release from our GitHub repository and follow the instructions for your platform below:
- Linux
- macOS
- Windows
Prerequisites
- amd64 or arm64 Linux.
- Ensure
~/.local/bin
is on yourPATH
:echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
mkdir -p ~/.local/bin
Installation
- Download the latest Linux archive (e.g.
oasis_cli_X.Y.Z_linux_amd64.tar.gz
). - Extract it:
cd ~/Downloads
tar -xzf oasis_cli_X.Y.Z_linux_amd64.tar.gz # adjust version and architecture - Move the binary to your path:
mv oasis ~/.local/bin/
- Verify:
oasis --version
Prerequisites
- macOS (Apple Silicon & Intel).
- Ensure
~/.local/bin
is on yourPATH
(add it in~/.zshrc
or~/.bashrc
):echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
mkdir -p ~/.local/bin
Installation
- Download the latest macOS archive (e.g.
oasis_cli_X.Y.Z_darwin_all.tar.gz
) from the releases page. - Extract it:
cd ~/Downloads
tar -xzf oasis_cli_X.Y.Z_darwin_all.tar.gz # adjust version - Move the binary to your path:
mv oasis ~/.local/bin/
- Bypass Gatekeeper (first run only):
If a dialog appears, open System Settings → Privacy & Security and click Open Anyway.
xattr -d com.apple.quarantine ~/.local/bin/oasis
- Verify:
oasis --version
Prerequisites
- Windows 10/11 (x86-64).
- Decide on a folder already in your
PATH
(e.g.%USERPROFILE%\bin
) or add one.
Installation
- Download the latest Windows ZIP file (e.g.
oasis_cli_X.Y.Z_windows_amd64.zip
). - Extract it (double-click or
tar -xf
in PowerShell). - Copy
oasis.exe
to a directory on yourPATH
, for example:If that folder isn’t on theNew-Item -ItemType Directory -Force "$env:USERPROFILE\bin"
Copy-Item .\oasis.exe "$env:USERPROFILE\bin\"PATH
, add it via System Properties → Environment Variables. - Verify:
oasis --version
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.
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
:
oasis wallet list --config ~/.config/oasis_dev/cli.toml
ACCOUNT KIND ADDRESS
oscar file (ed25519-adr8:0) oasis1qp87hflmelnpqhzcqcw8rhzakq4elj7jzv090p3e
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.