Cardano Up!
Overview
This Ruby gem provides easy way for:
- getting
cardano-node,cardano-cli,cardano-wallet,cardano-addressesandbech32tools onto your system (Linux, MacOS or Windows). - getting configuration for any Cardano public environment.
- starting, managing and monitoring cardano-node and cardano-wallet services.
Installation
Rubygem:
$ gem install cardano-up
$ cardano-up --help
Nix:
$ nix develop github:piotr-iohk/cardano-up?dir=nix
$ cardano-up --help
or run directly
$ nix run github:piotr-iohk/cardano-up?dir=nix -- --help
Usage
It only takes a single command to start node and wallet on your system. Say, on mainnet?
$ cardano-up mainnet up
That's it! 🎉
If any configs are missing cardano-up will download them. If any binaries are missing cardano-up will get ones from latest release.
To explore more options call:
$ cardano-up --help
$ cardano-up --examples
Documentation
| Link | Description |
|---|---|
| Usage examples | Also available in $ cardano-up --examples |
| Ruby API (edge) | cardano-up API doc |
How it works
By default cardano-up keeps all files at $HOME/.cardano-up/ however this can be configured by editing $HOME/.cardano-up/.cardano-up.json directly or via config sub-command. One can check the contents of this internal config file by calling $ cardano-up config.
Configurations for the networks are downloaded from Cardano Book.
Binaries come from cardano-wallet which actually provides cardano-node, cardano-cli, cardano-wallet, cardano-addresses and bech32 tools in each of its release bundles. This ensures that all components are compatible and work smoothly together. You can get any public release of the cardano-wallet bundle.
Starting cardano-node and cardano-wallet, cardano-up attempts to launch separate screen sessions for wallet and node respectively. If screen is not present on your system you can install it using package manager, e.g.:
MacOS:
$ brew install screen
Linux:
$ sudo apt-get install screen
In case of Windows it will attempt to install cardano-node and cardano-wallet as Windows services using nssm tool. Nssm can be installed via choco package manager:
$ choco install nssm
:warning: nssm requires administrator permissions to register Windows services, therefore you need to start your cmd as an administrator.
There is also basic session management in cardano-up. In a single session you can have at most 1 node and 1 wallet for particular network. Because of the sessions you can quickly check details of your running components (like where are the log or database files or what ports are used) and you have some basic tools to monitor them (via tail and ping subcommands).
License
The gem is available as open source under the terms of the MIT License.