Installing Corda CLI

Instructions on how to install the Corda CLI tool.

Automated installation

Use the bash installation script to automate the manual steps. This script downloads Corda CLI, adds it to the path, and sets the auto-completion for Corda CLI to your bash/zsh profile. On Windows the script can run on a git-bash terminal.

Run the bash script:

curl "https://download.corda.net/corda-cli/1.0.0-DevPreview/get-corda-cli.sh" | bash

Manual installation

Before you start

If a previous installation of Corda CLI exists, remove it. See Deleting Corda CLI .

Steps

  1. Download either the .tar or .zip file.

  2. Create a new bin/corda-cli directory under the current users home directory.

  3. Extract the previously-downloaded archive into this new directory.

    Once extracted, your folder structure should be:

    bin/corda-cli
     ├───bin
     │   └───complete
     └───lib
    
  4. Windows: Add Corda CLI to PATH:

    a. Go to the Edit the system environment variables Control Panel setting.

    b. Edit the Path user variable and add the Corda CLI bin directory extracted in the previous step as a new entry. For example, C:\Users\username\bin\corda-cli\bin.

    c. If you are using Git Bash, update your home directory username/.bashrc file with the code:

       # Corda-CLI default path
       export PATH="$HOME/bin/corda-cli/bin:$PATH"
       if [[ -f $HOME/bin/corda-cli/bin/complete/corda-cli_completion.sh ]]; then
       source $HOME/bin/corda-cli/bin/complete/corda-cli_completion.sh
       fi
    
  5. Linux or macOS: Add Corda CLI to PATH by adding this code to the ~/.bashrc (Linux) or ~/.zshrc file (macOS):

      # Corda-CLI default path
      export PATH="$HOME/bin/corda-cli/bin:$PATH"
      if [[ -f $HOME/bin/corda-cli/bin/complete/corda-cli_completion.sh ]]; then
      source $HOME/bin/corda-cli/bin/complete/corda-cli_completion.sh
      fi
    
  6. Verify installation by opening a new terminal session and running corda-cli -v.

    Step result: If successful, this will output details of the installed Corda CLI version.

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.