-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Replace oasis-node CLI with oasis CLI docs
- Loading branch information
Showing
12 changed files
with
430 additions
and
37 deletions.
There are no files selected for viewing
This file contains 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 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 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 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,33 @@ | ||
| # Oasis CLI | ||
|
|
||
| Oasis command-line interface (CLI) is a powerful all-in-one tool for | ||
| interacting with the Oasis Network. You can download the latest release | ||
| binaries from the [GitHub repository]. | ||
|
|
||
| It boasts a number of handy features: | ||
|
|
||
| - Flexible setup: | ||
| - supports Mainnet, Testnet, Localnet or any other Oasis network deployment | ||
| - consensus layer configuration with arbitrary token | ||
| - configuration of custom ParaTimes with arbitrary token | ||
| - connecting to remote (via TCP/IP) or local (Unix socket) Oasis node | ||
| instance | ||
| - Powerful wallet features: | ||
| - standard token operations (transfers, allowances, deposits, withdrawals and | ||
| balance queries) | ||
| - file-based wallet with password protection | ||
| - full Ledger hardware wallet support | ||
| - address book | ||
| - generation, signing and submitting transactions in non-interactive mode | ||
| - offline transaction generation for air-gapped machines | ||
| - transaction encryption with Deoxys-II envelope | ||
| - Ed25519 and Ethereum-compatible Secp256k1 encryption schemes | ||
| - raw, BIP-44, ADR-8 and Ledger's legacy derivation paths | ||
| - Developer and devops features: | ||
| - Oasis node inspection and healthchecks | ||
| - official testing accounts for Oasis Localnet, test runners and debugging | ||
| - WebAssembly smart contract code deployment, instantiation, management and | ||
| calls | ||
| - debugging tools for deployed WebAssembly contracts | ||
|
|
||
| [GitHub repository]: https://github.com/oasisprotocol/cli/releases |
30 changes: 4 additions & 26 deletions
30
...osit-withdraw-tokens-to-from-paratime.mdx → docs/general/manage-tokens/cli/accounts.mdx
This file contains 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 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,96 @@ | ||
| # Setup | ||
|
|
||
| ## Download and Run | ||
|
|
||
| Download the latest release [here][cli-releases] and extract it to your | ||
| favorite application folder. | ||
|
|
||
| :::info | ||
|
|
||
| Oasis is currently providing official builds for x86 Linux only. If you want | ||
| to run it on another platform, you will have to [build it from source][cli-source]. | ||
|
|
||
| ::: | ||
|
|
||
| :::info | ||
|
|
||
| We suggest that you update your system path to include a directory containing | ||
| `oasis` binary or create a symbolic link to `oasis` in your | ||
| system path, so you can access it globally. | ||
|
|
||
| ::: | ||
|
|
||
| Run the Oasis CLI by typing `oasis`: | ||
|
|
||
| ``` | ||
| $ oasis | ||
| CLI for interacting with the Oasis network | ||
| Usage: | ||
| oasis [command] | ||
| Available Commands: | ||
| accounts Account operations | ||
| addressbook Manage addresses in the local address book | ||
| completion Generate the autocompletion script for the specified shell | ||
| contracts WebAssembly smart contracts operations | ||
| help Help about any command | ||
| inspect Inspect the network | ||
| network Manage network endpoints | ||
| paratime Manage paratimes | ||
| registry Registry operations | ||
| tx Raw transaction operations | ||
| wallet Manage accounts in the local wallet | ||
| Flags: | ||
| --config string config file to use | ||
| -h, --help help for oasis | ||
| -v, --version version for oasis | ||
| Use "oasis [command] --help" for more information about a command. | ||
| ``` | ||
|
|
||
| When running 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 [Oasis-supported ParaTimes][paratimes]. | ||
|
|
||
| ## Configuration | ||
|
|
||
| The configuration folder of Oasis CLI is located: | ||
|
|
||
| - on Windows: | ||
| - `%USERPROFILE%\AppData\Roaming\Oasis\` | ||
| - on macOS: | ||
| - `/Users/$USER/Library/Application Support/Oasis/` | ||
| - on Linux: | ||
| - `$HOME/.config/oasis/` | ||
|
|
||
| There, you will find `cli.toml` which contains configuration of the networks, | ||
| ParaTimes and your wallet. Additionally, each file-based account in your wallet | ||
| will have a separate, password-encrypted `.toml` file in the same folder named | ||
| after the name of the account and `.wallet` extension. | ||
|
|
||
| You can have multiple profiles of your wallet. To use a different profile, pass | ||
| `--config` parameter pointing to a specific `cli.toml` file. | ||
|
|
||
| ``` | ||
| $ oasis wallet create myaccount | ||
| $ oasis wallet list | ||
| ACCOUNT KIND ADDRESS | ||
| myaccount file (ed25519-adr8:0) oasis1qq59js97ytn2xcnscyx9n25z5y4dc6z6qcqsydyr | ||
| $ mv ~/.config/oasis ~/.config/oasis_work | ||
| $ oasis wallet list | ||
| ACCOUNT KIND ADDRESS | ||
| $ oasis wallet list --config ~/.config/oasis_work/cli.toml | ||
| ACCOUNT KIND ADDRESS | ||
| myaccount file (ed25519-adr8:0) oasis1qq59js97ytn2xcnscyx9n25z5y4dc6z6qcqsydyr | ||
| ``` | ||
|
|
||
| ## Backing up your wallet | ||
|
|
||
| To back up your wallet, simply archive the folder containing `cli.toml` and | ||
| `.wallet` files. | ||
|
|
||
| [cli-releases]: https://github.com/oasisprotocol/cli/releases | ||
| [cli-source]: https://github.com/oasisprotocol/cli | ||
| [paratimes]: ../../../dapp/README.mdx |
Oops, something went wrong.