Skip to content

Commit 173b3d1

Browse files
uniyalabhishekuniyalabhishek
committed
fix: mardown warnings
1 parent 6fd41e5 commit 173b3d1

1 file changed

Lines changed: 106 additions & 108 deletions

File tree

‎docs/README.md‎

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

66
# Oasis Command Line Interface
77

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
10-
binaries from the [GitHub repository].
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
10+
binaries from the [GitHub repository] (see the “Installing or Updating Oasis
11+
CLI on macOS” section below for macOS-specific instructions).
1112

1213
It boasts a number of handy features:
1314

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
15+
- Flexible setup:
16+
- supports Mainnet, Testnet, Localnet or any other deployment of the Oasis
17+
network
18+
- consensus layer configuration with arbitrary token
19+
- configuration of custom ParaTimes with arbitrary token
20+
- connecting to remote (via TCP/IP) or local (Unix socket) Oasis node
21+
instance
22+
- Powerful wallet features:
23+
- standard token operations (transfers, allowances, deposits, withdrawals
24+
and balance queries)
25+
- file-based wallet with password protection
26+
- full Ledger hardware wallet support
27+
- address book
28+
- generation, signing and submitting transactions in non-interactive
29+
(headless) mode
30+
- offline transaction generation for air-gapped machines
31+
- transaction encryption with X25519-Deoxys-II envelope
32+
- support for Ed25519, Ethereum-compatible Secp256k1 and Sr25519 signature
33+
schemes
34+
- raw, BIP-44, ADR-8 and Ledger’s legacy derivation paths
35+
- Node operator features:
36+
- Oasis node inspection and health-checks
37+
- network governance transactions
38+
- staking reward schedule transactions
39+
- Developer features:
40+
- built-in testing accounts compatible with the Oasis test runner, the Oasis
41+
CI and the official Sapphire and Emerald Localnet Docker images
42+
- Oasis ROFL app compilation, deployment and management
43+
- Oasis Wasm smart contract code deployment, instantiation, management and
44+
calls
45+
- debugging tools for deployed Wasm contracts
46+
- inspection of blocks, transactions, results and events
47+
48+
[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
5657

5758
- macOS (tested on Apple Silicon).
5859
- 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):
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):
6263

63-
```
64-
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
65-
source ~/.zshrc
66-
```
64+
```bash
65+
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
66+
source ~/.zshrc
67+
```
6768

68-
- Create the directory if it doesn't exist: `mkdir -p ~/.local/bin`.
69+
Create the directory if it doesn't exist:
6970

70-
#### Installation Steps
71+
```bash
72+
mkdir -p ~/.local/bin
73+
```
7174

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).
75+
### Installation Steps
7876

79-
2. **Extract the Archive**:
80-
- Open Terminal and navigate to your Downloads folder:
77+
1. **Download the Binary**
8178

82-
```
83-
cd ~/Downloads
84-
```
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`).
8583

86-
- Extract the file (replace with your version):
84+
2. **Extract the Archive**
8785

88-
```
89-
tar -xzf oasis_cli_0.14.1_darwin_all.tar.gz
90-
```
86+
```bash
87+
cd ~/Downloads
88+
tar -xzf oasis_cli_0.14.1_darwin_all.tar.gz # replace with your version
89+
```
9190

92-
- This creates a directory like `oasis_cli_0.14.1_darwin_all`.
91+
This creates a directory such as `oasis_cli_0.14.1_darwin_all`.
9392

94-
3. **Navigate to the Extracted Directory**:
93+
3. **Navigate to the Extracted Directory**
9594

96-
```
97-
cd oasis_cli_0.14.1_darwin_all
98-
```
95+
```bash
96+
cd oasis_cli_0.14.1_darwin_all
97+
```
9998

100-
4. **Move the Binary to User Path**:
99+
4. **Move the Binary to the User Path**
101100

102-
```
103-
mv oasis ~/.local/bin/
104-
```
101+
```bash
102+
mv oasis ~/.local/bin/
103+
```
105104

106-
5. **Bypass macOS Gatekeeper (if prompted with a security warning)**:
105+
5. **Bypass macOS Gatekeeper** (if you encounter a security warning)
107106

108-
```
109-
xattr -d com.apple.quarantine ~/.local/bin/oasis
110-
```
107+
```bash
108+
xattr -d com.apple.quarantine ~/.local/bin/oasis
109+
```
111110

112-
- If a dialog appears, go to System Settings > Privacy & Security >
113-
Security, and click "Open Anyway".
111+
If a dialog appears, go to **System Settings → Privacy & Security →
112+
Security**
113+
and click **“Open Anyway.”**
114114

115-
6. **Verify Installation**:
115+
6. **Verify Installation**
116116

117-
```
118-
oasis --version
119-
```
117+
```bash
118+
oasis --version
119+
```
120120

121-
- This should display the CLI version. If successful, the Oasis CLI is
122-
installed and ready to use.
121+
The CLI version should be displayed. If so, the Oasis CLI is installed and
122+
ready to use.
123123

124-
## Updating the Oasis CLI
124+
### Updating the Oasis CLI
125125

126126
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).
127+
the latest version. Your configurations (wallets, settings) are preserved.
128+
129+
1. **Check Current Version**
129130

130-
1. **Check Current Version**:
131+
```bash
132+
oasis --version
133+
```
131134

132-
```
133-
oasis --version
134-
```
135+
Compare the output with the latest version on the [GitHub repository] to
136+
see if an update is available.
135137

136-
Compare with the latest on <https://github.com/oasisprotocol/cli/releases>
137-
to see if an update is available.
138+
2. **Update Process**
138139

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.
140+
Follow the same installation steps above using the new version archive.
141+
Because you are overwriting the existing binary, no additional cleanup is
142+
required.
143143

144-
## Notes
144+
### Notes
145145

146-
- Clean up: Optionally delete the downloaded .tar.gz and extracted directory
147-
after installation/update.
146+
- Clean-up: You can delete the downloaded `.tar.gz` file and extracted
147+
directory after installation or update.
148148
- For major version updates, review the release notes on GitHub for any
149149
breaking changes or additional steps.
150-
151-
[GitHub repository]: https://github.com/oasisprotocol/cli/releases

0 commit comments

Comments
 (0)