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.7.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.

  • 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.
  • 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.7.jar
Network bootstrapper bootstrapper --<option> corda-tools-network-bootstrapper-4.7.jar
Standalone shell corda-shell --<option> corda-tools-shell-cli-4.7.jar
Blob inspector blob-inspector --<option> corda-tools-blob-inspector-4.7.jar

List of existing Enterprise CLI applications

Database Manager database-manager --<option> corda-tools-database-manager-4.7.jar Corda Firewall corda-firewall --<option> corda-firewall-4.7.jar |

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.