diff --git a/docs/source/blob-inspector.rst b/docs/source/blob-inspector.rst index f0948ee0dc..abe76b8711 100644 --- a/docs/source/blob-inspector.rst +++ b/docs/source/blob-inspector.rst @@ -97,3 +97,25 @@ Here's what a node-info file from the node's data directory may look like: Notice the file is actually a serialised ``SignedNodeInfo`` object, which has a ``raw`` property of type ``SerializedBytes``. This property is materialised into a ``NodeInfo`` and is output under the ``deserialized`` field. + +Command-line options +~~~~~~~~~~~~~~~~~~~~ + +The blob inspector can be started with the following command-line options: + +.. code-block:: shell + + blob-inspector [-hvV] [--full-parties] [--install-shell-extensions] [--schema] + [--format=type] [--input-format=type] + [--logging-level=] [SOURCE] + +* ``--format=type``: Output format. Possible values: [YAML, JSON]. Default: YAML. +* ``--input-format=type``: Input format. If the file can't be decoded with the given value it's auto-detected, so you should + never normally need to specify this. Possible values [BINARY, HEX, BASE64]. Default: BINARY. +* ``--full-parties``: Display the owningKey and certPath properties of Party and PartyAndReference objects respectively. +* ``--schema``: Print the blob's schema first. +* ``--verbose``, ``--log-to-console``, ``-v``: If set, prints logging to the console as well as to a file. +* ``--logging-level=``: Enable logging at this level and higher. Possible values: ERROR, WARN, INFO, DEBUG, TRACE. Default: INFO. +* ``--install-shell-extensions``: Install ``blob-inspector`` alias and auto completion for bash and zsh. See :doc:`cli-application-shell-extensions` for more info. +* ``--help``, ``-h``: Show this help message and exit. +* ``--version``, ``-V``: Print version information and exit. \ No newline at end of file diff --git a/docs/source/cli-application-shell-extensions.rst b/docs/source/cli-application-shell-extensions.rst new file mode 100644 index 0000000000..4c81ea6c07 --- /dev/null +++ b/docs/source/cli-application-shell-extensions.rst @@ -0,0 +1,76 @@ +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 .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 + + --