ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-19 13:08:04 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
8e590cfc55
corda/docs/source/cli-application-shell-extensions.rst
Anthony Keenan 99dd2c5936
CORDA-1764: Make blobinspector use picocli base class (#3940) 
* Make blobinspector use picocli base class

* Updated Documentation

* Update and harmonise documentation

* Give the table a bit more padding to help with merge conflicts

* Correct capitalisation of short options

* Some grammar changes
2018-09-14 16:37:58 +01:00

3.5 KiB
Raw Blame History

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-<version>.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<installing-shell-extensions> 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<installing-shell-extensions> for instructions on making the changes take effect immediately.

List of existing CLI applications

Description JAR name Alias
Corda node<starting-an-individual-corda-node> corda-<version>.jar corda --<option>
Network bootstrapper<network-bootstrapper> corda-tools-network-bootstrapper-<version>.jar bootstrapper --<option>
Standalone shell<standalone-shell> corda-tools-shell-cli-<version>.jar corda-shell --<option>
Blob inspector<blob-inspector> corda-tools-blob-inspector-<version>.jar blob-inspector --<option>