mirror of
https://github.com/corda/corda.git
synced 2024-12-27 16:28:56 +00:00
99dd2c5936
* 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
77 lines
3.5 KiB
ReStructuredText
77 lines
3.5 KiB
ReStructuredText
Shell extensions for CLI Applications
|
|
=====================================
|
|
|
|
.. _installing-shell-extensions:
|
|
|
|
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:
|
|
|
|
.. code-block:: shell
|
|
|
|
java -jar <name-of-JAR>.jar --install-shell-extensions
|
|
|
|
Then, either restart your shell, or for ``bash`` users run:
|
|
|
|
.. code-block:: shell
|
|
|
|
. ~/.bashrc
|
|
|
|
Or, for ``zsh`` run:
|
|
|
|
.. code-block:: shell
|
|
|
|
. ~/.zshrc
|
|
|
|
You will now be able to run the command line application from anywhere by running the following:
|
|
|
|
.. code-block:: shell
|
|
|
|
<alias> --<option>
|
|
|
|
For example, for the Corda node, install the shell extensions using
|
|
|
|
.. code-block:: shell
|
|
|
|
java -jar corda-<version>.jar --install-shell-extensions
|
|
|
|
And then run the node by running:
|
|
|
|
.. code-block:: shell
|
|
|
|
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 :ref:`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:
|
|
|
|
.. code-block:: shell
|
|
|
|
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 :ref:`above<installing-shell-extensions>` for instructions on making the changes take effect immediately.
|
|
|
|
List of existing CLI applications
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
+----------------------------------------------------------------+--------------------------------------------------------------+--------------------------------+
|
|
| Description | JAR name | Alias |
|
|
+----------------------------------------------------------------+--------------------------------------------------------------+--------------------------------+
|
|
| :ref:`Corda node<starting-an-individual-corda-node>` | ``corda-<version>.jar`` | ``corda --<option>`` |
|
|
+----------------------------------------------------------------+--------------------------------------------------------------+--------------------------------+
|
|
| :doc:`Network bootstrapper<network-bootstrapper>` | ``corda-tools-network-bootstrapper-<version>.jar`` | ``bootstrapper --<option>`` |
|
|
+----------------------------------------------------------------+--------------------------------------------------------------+--------------------------------+
|
|
| :ref:`Standalone shell<standalone-shell>` | ``corda-tools-shell-cli-<version>.jar`` | ``corda-shell --<option>`` |
|
|
+----------------------------------------------------------------+--------------------------------------------------------------+--------------------------------+
|
|
| :doc:`Blob inspector<blob-inspector>` | ``corda-tools-blob-inspector-<version>.jar`` | ``blob-inspector --<option>`` |
|
|
+----------------------------------------------------------------+--------------------------------------------------------------+--------------------------------+
|
|
|