Repository files navigation

This is the official command-line interface (CLI) for interacting with theOasis Network, both the consensus layer and ParaTimes built with theOasis Runtime SDK.

To build the CLI, run the following:

make

This will generate a binary calledoasis which you are free to put somewherein your$PATH.

NOTE: The rest of the README assumes theoasis binary is somewhere in your$PATH.

You can interact with the Oasis CLI by invoking it from the command line asfollows:

oasis --help

Each (sub)command has a help section that shows what commands and arguments areavailable.

The Oasis CLI also comes with a default set of networks and ParaTimesconfigured. You can see the list by running:

oasis network listoasis paratime list

Initial configuration currently defaults tomainnet and theemeraldParaTime but this can easily be changed using the correspondingset-defaultsubcommand as follows:

oasis network set-default testnetoasis paratime set-default testnet sapphire

To be able to sign transactions you will need to first create or import anaccount into your wallet. File-based (storing keys in an encrypted file) andLedger-based (storing keys on a Ledger device) backends are supported.To create a new file-backed account run:

oasis wallet create myaccount

It will ask you to choose and confirm a passphrase to encrypt your account with.You can see a list of all accounts by running:

oasis wallet list

To show the account's balance on the default network/ParaTime, run:

oasis account show

Theaccount command also allows you to transfer tokens, deposit or withdraw toand from ParaTimes, delegate your assets to validators etc.

Check out the complete User's guide in [docs/README.md] and example invocationsof the CLI inexamples folder to learn more.

All configuration is stored in the$XDG_CONFIG_HOME/oasis directory (e.g.$HOME/.config/oasis on Linux).

This software is licensed underApache 2.0.

The content of the documentation (the/docs folder) including the media (e.g.images and diagrams) is licensed underCreative Commons Attribution 4.0International.