Skip to main content

Install the PMC CLI

This topic contains instructions to install and update Postchain Management Console (PMC) CLI.

Install​

You can download and install the latest PMC CLI by browsing https://gitlab.com/chromaway/postchain-chromia/-/packages and searching for the latest net/postchain/pmc-directory version or via a package manager:

brew tap chromia/core https://gitlab.com/chromaway/core-tools/homebrew-chromia.git
brew install pmc

Update​

You can download and install the latest PMC CLI by browsing https://gitlab.com/chromaway/postchain-chromia/-/packages and searching for the latest net/postchain/pmc-directory version to update it. You should remove the old files and then add the new ones to your file system at the exact location.

If you have installed the PMC CLI via a package manager, you can update it with:

brew update
brew upgrade pmc

Docker​

Docker can run a standalone Linux container with the PMC CLI pre-installed. Make sure that you have set up the PostgreSQL database.

To use the published Docker images, you must first have Docker installed and configured on your host machine. Please refer to the Docker documentation on how to install Docker on Windows, Mac, and Linux.

Start the Docker container with PMC CLI pre-installed​

To run the latest version of the PMC CLI, use the docker run command and specify the CLI docker image name and any of the pmc commands.

docker run --rm -v $(pwd):/usr/app -w /usr/app registry.gitlab.com/chromaway/postchain-chromia/chromaway/postchain-mc:<latest version> -h

You see the following prompt in the terminal:

Usage: pmc [OPTIONS] COMMAND [ARGS]...

Options:
  --generate-completion [bash|zsh|fish]
  --version                        Show the version and exit
  -h, --help                       Show this message and exit

Commands:
  keygen             Generates public/private key pair
  config             Configure the management console
  network            Commands relating to the network as a whole
  node               Node commands
  provider           Provider commands
  proposal           Interact with existing proposals
  voterset           Voter set commands
  cluster            Interacting with clusters
  container          Container commands
  blockchain         Interactions with blockchains
  cluster-anchoring  Interactions with cluster anchoring chain configuration

See the Docker command line reference for information about updating or uninstalling the Docker image.