Shell extensions for CLI Applications

Installing shell extensions

Users of bash or zsh can install an alias and auto-completion for Corda applications that contain a command line interface. Run:

java -jar <name-of-JAR>.jar install-shell-extensions

Then, either restart your shell, or for bash users run:

. ~/.bashrc

Or, for zsh run:

. ~/.zshrc

You will now be able to run the command line application from anywhere by running the following:

<alias> --<option>

For example, for the Corda node, install the shell extensions using

java -jar corda-4.3-SNAPSHOT.jar install-shell-extensions

And then run the node by running:

corda --<option>

Upgrading shell extensions

Once the shell extensions have been installed, you can upgrade them in one of two ways.

  1. Overwrite the existing JAR with the newer version. The next time you run the application, it will automatically update the completion file. Either restart the shell or see above for instructions on making the changes take effect immediately.

  2. If you wish to use a new JAR from a different directory, navigate to that directory and run:

    java -jar <name-of-JAR>
    

    Which will update the alias to point to the new location, and update command line completion functionality. Either restart the shell or see above for instructions on making the changes take effect immediately.

List of existing CLI applications

Description Alias JAR Name
Corda node corda --<option> corda-4.3-SNAPSHOT.jar
Network bootstrapper bootstrapper --<option> corda-tools-network-bootstrapper-4.3-SNAPSHOT.jar
Standalone shell corda-shell --<option> corda-tools-shell-cli-4.3-SNAPSHOT.jar
Blob inspector blob-inspector --<option> corda-tools-blob-inspector-4.3-SNAPSHOT.jar