Skip to content

Latest commit

 

History

History
74 lines (60 loc) · 3.67 KB

COMMAND_LINE.md

File metadata and controls

74 lines (60 loc) · 3.67 KB
Raw

💻 Command-Line Interface

Table of content

  1. Overview
  2. Options
  3. Auto-Completion

Overview

$ ogmios --help
Provides a bridge between cardano-node and WebSocket clients. Ogmios translates
the existing CBOR-based Ouroboros mini-protocols into JSON-WSP-based protocols,
through WebSocket channels.

Usage: ogmios --node-socket FILEPATH [--host IPv4] [--port TCP/PORT]
              [--public-url URI] [--log-level SEVERITY]
  Ogmios - A JSON-WSP WebSocket adaptor for cardano-node

Available options:
  -h,--help                Show this help text
  --node-socket FILEPATH   Path to the node socket.
  --host IPv4              Address to bind to. (default: "127.0.0.1")
  --port TCP/PORT          Port to listen on. (default: 1337)
  --public-url URI         Public URL, if any, from which Ogmios is accessible
                           when hosted.
  --log-level SEVERITY     Minimal severity required for logging.
                           --------------------
                           - Debug
                           - Info
                           - Notice
                           - Warning
                           - Error
                           - Critical
                           - Alert
                           - Emergency
                           -------------------- (default: Info)

Revision:
  git@fe571250b7659dff0efdd9b275db147074ed8578

Options

Option Description 
--node-socket
Path to the cardano-node socket file. This is where the Ogmios and cardano-node gets to exchange information. This file can't be accessed remotely which means that Ogmios and cardano-node must be running on the same host machine. 
--host
Optional, what host address to bind to. One would typically leave the default value here unless running inside a container. In the latter case, one would typically want to listen on all interfaces and provide 0.0.0.0. 
--port
Optional, which port to bind to. 
--public-url
Optional, appears in the JSON-WSP description (ogmios.wsp.json) as the service URL. This only makes sense when Ogmios is hosted as a public service. 
--log-level
Increase or decrease logging severity.

Auto-Completion

Auto-completion is supported almost out-of-the-box for bash users by placing the following script in /etc/bash_completion.d:

_ogmios()
{
   local CMDLINE
   local IFS=$'\n'
   CMDLINE=(--bash-completion-index $COMP_CWORD)

   for arg in ${COMP_WORDS[@]}; do
       CMDLINE=(${CMDLINE[@]} --bash-completion-word $arg)
   done

   COMPREPLY=( $(ogmios "${CMDLINE[@]}") )
}

complete -o filenames -F _ogmios ogmios