Installing the Corda CLI heading-link-icon

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.

SoftwareVersion
JavaAzul JDK 17

To obtain the Corda CLI installer compatible with your version of Corda, download one of the following:

  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-<version number>.zip.

  4. Extract the contents of the zip file:

    unzip ./corda-cli-installer-<version number>.zip -d corda-cli-installer-<version number>
    
  5. Change directory to the directory extracted from the zip file:

    cd corda-cli-installer-<version number>
    
  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.

  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-<version number>.zip.

  4. Extract the contents of the zip file:

    Expand-Archive .\corda-cli-installer-<version number>.zip
    
  5. Change directory to the directory extracted from the zip file:

    cd corda-cli-installer-<version number>
    
  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.

  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.

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.