Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oasisprotocol/cli
Official CLI for the Oasis Network.
https://github.com/oasisprotocol/cli
blockchain cli crypto ledger non-custodial oasis official rose staking terminal wallet
Last synced: 1 day ago
JSON representation
Official CLI for the Oasis Network.
- Host: GitHub
- URL: https://github.com/oasisprotocol/cli
- Owner: oasisprotocol
- License: apache-2.0
- Created: 2022-09-16T16:05:09.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T09:26:39.000Z (7 months ago)
- Last Synced: 2024-04-22T10:38:15.930Z (7 months ago)
- Topics: blockchain, cli, crypto, ledger, non-custodial, oasis, official, rose, staking, terminal, wallet
- Language: Go
- Homepage:
- Size: 1.08 MB
- Stars: 12
- Watchers: 11
- Forks: 1
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Oasis CLI
[![CI tests status][github-ci-tests-badge]][github-ci-tests-link]
[![CI lint status][github-ci-lint-badge]][github-ci-lint-link]
[github-ci-tests-badge]: https://github.com/oasisprotocol/cli/workflows/ci-tests/badge.svg
[github-ci-tests-link]: https://github.com/oasisprotocol/cli/actions?query=workflow:ci-tests+branch:master
[github-ci-lint-badge]: https://github.com/oasisprotocol/cli/workflows/ci-lint/badge.svg
[github-ci-lint-link]: https://github.com/oasisprotocol/cli/actions?query=workflow:ci-lint+branch:master
This is the official command-line interface (CLI) for interacting with the
[Oasis Network], both the consensus layer and ParaTimes built with the
[Oasis Runtime SDK].
[Oasis Network]: https://docs.oasis.io/
[Oasis Runtime SDK]:
https://github.com/oasisprotocol/oasis-sdk/tree/main/runtime-sdk
## Building
To build the CLI, run the following:
```bash
make
```
This will generate a binary called `oasis` which you are free to put somewhere
in your `$PATH`.
*NOTE: The rest of the README assumes the `oasis` binary is somewhere in your
`$PATH`.*
## Quickstart
You can interact with the Oasis CLI by invoking it from the command line as
follows:
```bash
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 the list by running:
```bash
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:
```bash
oasis network set-default testnet
oasis paratime set-default testnet sapphire
```
To be able to sign transactions you will need to first create or import an
account into your wallet. File-based (storing keys in an encrypted file) and
Ledger-based (storing keys on a Ledger device) backends are supported.
To create a new file-backed account run:
```bash
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:
```bash
oasis wallet list
```
To show the account's balance on the default network/ParaTime, run:
```bash
oasis account show
```
The `account` command also allows you to transfer tokens, deposit or withdraw to
and from ParaTimes, delegate your assets to validators etc.
Check out the complete User's guide in [docs/README.md] and example invocations
of the CLI in `examples` folder to learn more.
## Configuration
All configuration is stored in the `$XDG_CONFIG_HOME/oasis` directory (e.g.
`$HOME/.config/oasis` on Linux).
## License
This software is licensed under [Apache 2.0](./LICENSE).
The content of the documentation (the `/docs` folder) including the media (e.g.
images and diagrams) is licensed under [Creative Commons Attribution 4.0
International](./LICENSE-docs).