Corda 5 Developer Preview 2 is now available.

Installing the Corda CLI

Corda CLI (command line interface) is a command line tool that supports various Corda related tasks, including Corda Package Installer (CPI) creation and Corda cluster management. Direct use of Corda CLI by Developers is not in scope for Developer Preview 2. However, the CorDapp Standard Development Environment (CSDE) uses Corda CLI in the background. As a result, you must install Corda CLI before using CSDE.

Downloading Corda CLI

To install Corda CLI, download the installation zip file from https://download.corda.net/packages/corda-cli-downloader/5.0.0.0-DevPreview-2/corda-cli-downloader-5.0.0.0-DevPreview-2.zip.

Installing on Linux/macOS

  1. Start a shell session (bash or zsh).
  2. Change directory to where you downloaded corda-cli-downloader-5.0.0.0-DevPreview-2.zip.
  3. Extract the contents of the zip file:
    unzip ./corda-cli-downloader-5.0.0.0-DevPreview-2.zip -d corda-cli-downloader-5.0.0.0-DevPreview-2
    
  4. Change directory to the directory extracted from the zip file:
    cd corda-cli-downloader-5.0.0.0-DevPreview-2
    
  5. 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.

Installing on Windows

  1. Start a Powershell session.

  2. Change directory to where you downloaded corda-cli-downloader-5.0.0.0-DevPreview-2.zip.

  3. Extract the contents of the zip file:

    Expand-archive .\corda-cli-downloader-5.0.0.0-DevPreview-2.zip
    
  4. Change directory to the directory extracted from the zip file:

    cd corda-cli-downloader-5.0.0.0-DevPreview-2
    
  5. 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.

Was this page helpful?

Thanks for your feedback!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

We're sorry this page wasn't helpful. Let us know how we can make it better!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Create an issue

Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.