Skip to content

Commit f44b34c

Browse files
uniyalabhishekuniyalabhishek
committed
fix: update readme instead of setupmd
1 parent 13a93ff commit f44b34c

1 file changed

Lines changed: 138 additions & 34 deletions

File tree

‎docs/README.md‎

Lines changed: 138 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,147 @@ description: Powerful CLI for managing Oasis networks, nodes, tokens and dApps
55

66
# Oasis Command Line Interface
77

8-
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
8+
The Oasis Command Line Interface (CLI) is a powerful, all-in-one tool for
9+
interacting with the Oasis Network. [5] You can download the latest release
1010
binaries from the [GitHub repository].
1111

1212
It boasts a number of handy features:
1313

14-
- Flexible setup:
15-
- supports Mainnet, Testnet, Localnet or any other deployment of the Oasis
16-
network
17-
- consensus layer configuration with arbitrary token
18-
- configuration of custom ParaTimes with arbitrary token
19-
- connecting to remote (via TCP/IP) or local (Unix socket) Oasis node
20-
instance
21-
- Powerful wallet features:
22-
- standard token operations (transfers, allowances, deposits, withdrawals and
23-
balance queries)
24-
- file-based wallet with password protection
25-
- full Ledger hardware wallet support
26-
- address book
27-
- generation, signing and submitting transactions in non-interactive
28-
(headless) mode
29-
- offline transaction generation for air-gapped machines
30-
- transaction encryption with X25519-Deoxys-II envelope
31-
- support for Ed25519, Ethereum-compatible Secp256k1 and Sr25519 signature
32-
schemes
33-
- raw, BIP-44, ADR-8 and Ledger's legacy derivation paths
34-
- Node operator features:
35-
- Oasis node inspection and healthchecks
36-
- network governance transactions
37-
- staking reward schedule transactions
38-
- Developer features:
39-
- built-in testing accounts compatible with the Oasis test runner, the Oasis
40-
CI and the official Sapphire and Emerald Localnet Docker images
41-
- Oasis ROFL app compilation, deployment and management
42-
- Oasis Wasm smart contract code deployment, instantiation, management and
43-
calls
44-
- debugging tools for deployed Wasm contracts
45-
- inspection of blocks, transactions, results and events
14+
- **Flexible setup**:
15+
- Supports Mainnet, Testnet, Localnet, or any other deployment of the Oasis
16+
network. [5]
17+
- Consensus layer configuration with an arbitrary token. [5]
18+
- Configuration of custom ParaTimes with an arbitrary token. [5]
19+
- Connecting to a remote (via TCP/IP) or local (Unix socket) Oasis node
20+
instance. [5]
21+
- **Powerful wallet features**:
22+
- Standard token operations (transfers, allowances, deposits, withdrawals,
23+
and balance queries). [5]
24+
- File-based wallet with password protection. [5]
25+
- Full Ledger hardware wallet support. [5]
26+
- Address book. [5]
27+
- Generation, signing, and submitting transactions in non-interactive
28+
(headless) mode. [5]
29+
- Offline transaction generation for air-gapped machines. [5]
30+
- Transaction encryption with X25519-Deoxys-II envelope. [5]
31+
- Support for Ed25519, Ethereum-compatible Secp256k1, and Sr25519 signature
32+
schemes. [5]
33+
- Raw, BIP-44, ADR-8, and Ledger's legacy derivation paths. [5]
34+
- **Node operator features**:
35+
- Oasis node inspection and health checks. [5]
36+
- Network governance transactions. [5]
37+
- Staking reward schedule transactions. [5]
38+
- **Developer features**:
39+
- Built-in testing accounts compatible with the Oasis test runner, the Oasis
40+
CI, and the official Sapphire and Emerald Localnet Docker images. [5]
41+
- Oasis ROFL app compilation, deployment, and management. [5]
42+
- Oasis Wasm smart contract code deployment, instantiation, management, and
43+
calls. [5]
44+
- Debugging tools for deployed Wasm contracts. [5]
45+
- Inspection of blocks, transactions, results, and events. [5]
46+
47+
## Installation
48+
49+
### macOS
50+
51+
This guide covers the installation or update process for the Oasis CLI on macOS
52+
(compatible with Apple Silicon like M1/M2/M3). It assumes you have Terminal
53+
access and basic command-line knowledge.
54+
55+
#### Prerequisites
56+
57+
- macOS (tested on Apple Silicon).
58+
- To avoid modifying system directories, we'll install the binary in a
59+
user-specific path (`~/.local/bin`). Ensure `~/.local/bin` is in your
60+
`PATH`. If not, add it by editing your shell configuration file (e.g.,
61+
`~/.zshrc` for zsh):
62+
63+
```
64+
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
65+
source ~/.zshrc
66+
```
67+
68+
- Create the directory if it doesn't exist: `mkdir -p ~/.local/bin`.
69+
70+
#### Installation Steps
71+
72+
1. **Download the Binary**:
73+
- Visit the Oasis CLI GitHub releases page:
74+
<https://github.com/oasisprotocol/cli/releases>.
75+
- Download the latest macOS archive, e.g.,
76+
`oasis_cli_X.Y.Z_darwin_all.tar.gz` (replace X.Y.Z with the version,
77+
like 0.14.1).
78+
79+
2. **Extract the Archive**:
80+
- Open Terminal and navigate to your Downloads folder:
81+
82+
```
83+
cd ~/Downloads
84+
```
85+
86+
- Extract the file (replace with your version):
87+
88+
```
89+
tar -xzf oasis_cli_0.14.1_darwin_all.tar.gz
90+
```
91+
92+
- This creates a directory like `oasis_cli_0.14.1_darwin_all`.
93+
94+
3. **Navigate to the Extracted Directory**:
95+
96+
```
97+
cd oasis_cli_0.14.1_darwin_all
98+
```
99+
100+
4. **Move the Binary to User Path**:
101+
102+
```
103+
mv oasis ~/.local/bin/
104+
```
105+
106+
5. **Bypass macOS Gatekeeper (if prompted with a security warning)**:
107+
108+
```
109+
xattr -d com.apple.quarantine ~/.local/bin/oasis
110+
```
111+
112+
- If a dialog appears, go to System Settings > Privacy & Security >
113+
Security, and click "Open Anyway".
114+
115+
6. **Verify Installation**:
116+
117+
```
118+
oasis --version
119+
```
120+
121+
- This should display the CLI version. If successful, the Oasis CLI is
122+
installed and ready to use.
123+
124+
## Updating the Oasis CLI
125+
126+
To update the Oasis CLI to a newer version, simply overwrite the binary with
127+
the latest version. This preserves your configurations (e.g., wallets and
128+
settings).
129+
130+
1. **Check Current Version**:
131+
132+
```
133+
oasis --version
134+
```
135+
136+
Compare with the latest on <https://github.com/oasisprotocol/cli/releases>
137+
to see if an update is available.
138+
139+
2. **Update Process**:
140+
Follow the same installation steps above with the new version. The key
141+
difference is that you're overwriting the existing binary rather than
142+
installing it fresh. Your configurations will be preserved.
143+
144+
## Notes
145+
146+
- Clean up: Optionally delete the downloaded .tar.gz and extracted directory
147+
after installation/update.
148+
- For major version updates, review the release notes on GitHub for any
149+
breaking changes or additional steps.
46150
47151
[GitHub repository]: https://github.com/oasisprotocol/cli/releases

0 commit comments

Comments
 (0)