Installing the Corda CLI

Corda CLI (command line interface) is a command line tool that supports various Corda-related tasks. For information about the commands available, see the Corda CLI reference content.

Third-Party Prerequisites

Downloading Corda CLI

To obtain the Corda CLI installer, download platform-jars-5.1.0.tar.gz from the R3 Developer Portal and extract corda-cli-installer-5.1.0.0.zip from net\corda\cli\deployment\corda-cli-installer\5.1.0.0.

Installing on Linux/macOS

1. Ensure that you remove any existing installations of Corda CLI by deleting the <user-home>/.corda/cli folder.

2. Start a shell session (bash or zsh).

3. Change directory to where you saved corda-cli-installer-5.1.0.0.zip.

4. Extract the contents of the zip file:

   unzip ./corda-cli-installer-5.1.0.0.zip -d corda-cli-installer-5.1.0.0
   

5. Change directory to the directory extracted from the zip file:

   cd corda-cli-installer-5.1.0.0
   

6. Run the install script:

   ./install.sh
   

   The script installs Corda CLI to <user-home>/.corda/cli, where <user-home> refers to your user home directory. For example, on macOS, this is typically something like /Users/charlie.smith or on Linux, something like /home/charlie.smith.

7. Add <user-home>/.corda/cli to your system’s Path environment variable.

8. Run the following command to verify your installation:

   ./corda-cli.sh -h
   

   If successful, this outputs details of the Corda CLI commands.

Installing on Windows

1. Ensure that you remove any existing installations of Corda CLI by deleting the <user-home>/.corda/cli folder.

2. Start a PowerShell session.

3. Change directory to where you saved corda-cli-installer-5.1.0.0.zip.

4. Extract the contents of the zip file:

   Expand-Archive .\corda-cli-installer-5.1.0.0.zip
   

5. Change directory to the directory extracted from the zip file:

   cd corda-cli-installer-5.1.0.0
   

6. Run the install script:

   .\install.ps1
   

   The script installs Corda CLI to <user-home>/.corda/cli, where <user-home> refers to your user home directory. On Windows, this is typically something like C:\Users\Charlie.Smith.

   If your PowerShell execution policy does not allow you to run this script, copy the contents to your own PowerShell script and execute that instead.

7. Add <user-home>/.corda/cli to your system’s Path environment variable.

8. Run the following command to verify your installation:

   corda-cli.cmd -h
   

   If successful, this outputs details of the Corda CLI commands.