Install PMC CLI

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

Prerequisite

Before proceeding, make sure the following prerequisites are met:

• PostgreSQL database: See Set up PostgreSQL database.

• Java Development Kit (JDK): Ensure that OpenJDK (version 21 or later) is installed. Follow this JDK installation guide for help.

Install

You can download and install the latest PMC CLI by browsing https://gitlab.com/chromaway/core-tools/management-console/-/packages and searching for the latest version or via a package manager.

Mac

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

Linux/WSL

Download the public key of apt-repo and add it to your local keyrings:

curl -fsSL https://apt.chromia.com/chromia.gpg | sudo tee /usr/share/keyrings/chromia.gpg >/dev/null

Add the repository to your list of package sources:

echo "deb [arch=amd64 signed-by=/usr/share/keyrings/chromia.gpg] https://apt.chromia.com stable main" | sudo tee /etc/apt/sources.list.d/chromia.list

Update apt-get and install:

sudo apt-get update
sudo apt-get install pmc

PowerShell

Using the PMC CLI on windows using PowerShell currently requires Docker Desktop for Windows. With Docker installed and running according to their documentation, you can prepend the following snippet to all commands to access the CLI:

docker run --rm -v "%cd%":/usr/app -w /usr/app registry.gitlab.com/chromaway/core-tools/management-console/pmc:<latest version>

note

You must specify host.docker.internal in database:host in your chromia.yml to make the CLI access the PostgreSQL instance running on the host machine or in another Docker container.

Update

You can download and install the latest PMC CLI from here, or if you have installed the PMC CLI via a package manager, you can update it with the following:

Mac

brew update
brew upgrade chromia/core/pmc

Linux

info

If you have added apt.chromia.com to your list of sources, you will need to add the flag --allow-releaseinfo-change when running the apt-get update command to allow apt to update the repository.
sudo apt-get --allow-releaseinfo-change update

Update apt-get and install:

sudo apt-get update
sudo apt-get install 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.

Unix-based systems:

docker run --rm -v $(pwd):/usr/app -w /usr/app registry.gitlab.com/chromaway/core-tools/management-console/pmc:<latest version>

Windows:

docker run --rm -v "%cd%":/usr/app -w /usr/app registry.gitlab.com/chromaway/core-tools/management-console/pmc:<latest version>

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