Skip to content
This repository has been archived by the owner. It is now read-only.
master
Switch branches/tags
Code

Deprecated Note:

This repository implements supports for Cardano Byron, and will not be updated to works on Cardano Shelley and further.

cardano-cli

Build Status MIT or APACHE-2 licensed Cardano Mainnet Cardano Staging Cardano Staging

The Cardano command line interface provides the following features:

  • powerful blockchain manager: with download, explore, verify, and analyze functions
  • ability to manage multiple wallets: Daedalus', Icarus' or custom wallets
  • flexible transaction build engine

This command line interface is built upon the Rust Cardano SDK.

Warning

  • The software is currently still in alpha phase, please do not use for any other purpose than debugging and testing, until stable releases are available.
  • While most of the operations in the CLI is in a reading state, and are thus relatively safe even in the presence of bugs, do take special note that transaction send will permanently change your state.
  • It ia advisable to trial testnet operations (depending on testnet availability), prior to completing mainnet operations.
  • If you think something is suspicious, it may very well be the case. Check the documentation, or ask for help.
  • Do not share your wallet mnemonics, passwords, cryptographic material, or pending signatures.

Installation guide

While it is recommended to wait for official releases, it is also possible to build the executable yourself by following these steps:

  1. install rust toolchain;
  2. clone the project repository (with the dependencies)
    git clone https://github.com/input-output-hk/cardano-cli.git --recursive
  3. build and install the binary:
    cd cardano-cli
    cargo install
  4. enjoy

Usage

Quick start

$ cardano-cli blockchain new mainnet
$ cardano-cli blockchain pull mainnet
$ cardano-cli wallet create "My Wallet"
$ cardano-cli wallet attach "My Wallet" mainnet
$ cardano-cli wallet sync   "My Wallet"
$ cardano-cli wallet status "My Wallet"

Complete documentation

Command line documentation

Supported platforms

Target test
aarch64-unknown-linux-gnu
arm-unknown-linux-gnueabi
armv7-unknown-linux-gnueabihf
i686-unknown-linux-gnu
i686-unknown-linux-musl
x86_64-unknown-linux-gnu
x86_64-unknown-linux-musl
i686-apple-darwin
x86_64-apple-darwin
x86_64-apple-darwin
i686-unknown-freebsd
x86_64-unknown-freebsd

Supported compiler versions

Rust test
stable
beta
nightly

We aim to support compiler versions as far as version 1.30. However, this is not a contract. Support of older compiler versions may be dropped in the future as we see fit.

License

This project is licensed under either of the following licenses:

Please choose your appropriate license.