cli

command module
Version: v0.0.0-...-9f09e3e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 12, 2022 License: Apache-2.0 Imports: 1 Imported by: 0

README

Oasis CLI

This is the command-line interface for interacting with the Oasis Network, both the consensus layer and paratimes based on the ParaTime SDK.

Building

To build the CLI run the following in this directory:

go build -o oasis

This will generate a binary called oasis which you are free to put somewhere in your $PATH (the rest of the README assumes as much).

Running

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

oasis --help

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

The Oasis CLI also comes with a default set of networks and paratimes configured, you can see a list by running:

oasis network list
oasis paratime list

Initial configuration currently defaults to mainnet and the emerald paratime but this can easily be changed using the corresponding set-default subcommand as follows:

oasis network set-default testnet
oasis paratime set-default testnet emerald

To be able to sign transactions you will need to first create or import an account into your wallet. Currently, only a local file-based backend is supported. To create a new 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 accounts show

Configuration

All configuration is stored in the $XDG_CONFIG_HOME/oasis directory (defaults to $HOME/.config/oasis).

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
cmd
Package metadata provides helpers for querying the metadata registry.
Package metadata provides helpers for querying the metadata registry.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL