GDA CLI Client

The gda client command allows users to manage GDA servers and clients, handling communication to start servers on remote machines.

The client is divided into serveral main subcommands. These can be listed using gda --help

$ gda --help
GDA launcher

Usage: gda [OPTIONS] <COMMAND>

Commands:
  server          Start, stop or check the status of the GDA server
  client          Start the client
  client-details  List the configuration that would be used to start the client
  launcher        Interact with the launcher process itself
  completions     Generate shell autocompletion - see help for details
  doctor          Print full diagnostics info for debugging (Unstable)
  help            Print this message or the help of the given subcommand(s)

Options:
  -H, --host <HOST>
          Host running the server process

  -p, --port <PORT>
          Port of the launcher service

  -G, --no-gui
          Prevent GUI pop-up being shown even if display is present
          
          This can also be made default locally by setting the `AMYGDALA_NO_GUI` environment
          variable (to anything - the value is ignored).

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Extending gda command
    Additional subcommands can be provided by naming external commands
    gda-* and ensuring they are executable and on your $PATH

Common Options

These options affect how the client runs and should be passed before any subcommand.

-H/--host

$ gda --host ixx-control

Set the address of the machine where amygdala is running. This defaults to $BEAMLINE-control is $BEAMLINE is set and localhost otherwise.

(NB, -H is used instead of -h to avoid clash with help)

-p/--port

$ gda --port 12345

Set the port on which the amygdala server is running. This defaults to 50051 if not set.

-G/--no-gui

$ gda --no-gui

Force the gda command to use the terminal for feedback instead of using the built-in GUIs. By default, the GUI is used if $DISPLAY is set and the terminal UI is used as a fallback if not, for instance if run remotely via SSH.

As the terminal UI does not show a confirmation prompt, using this option in a situation where there is no terminal available (via launcher menu or desktop entry etc) will result in the command running as normal but with no feedback given to the user.

If the GUI is never required for a user, setting $AMYGDALA_NO_GUI (to anything, the value is ignored) will be equivalent to passing --no-gui to every command.

-h/--help

$ gda --help

Show the help text (as shown above).

Subcommmands

• Server Interact with the GDA server managed by the amygdala daemon.

• Client Start the GDA client on the local machine

• Client Details Show the configuration that would be used to launch the client

• Launcher Manage the amygdala process itself

• Completions Generate shell completion functions to help interactions with gda command.

Help

Help is available at all levels of the gda command. Passing --help to any other command should generally provide help for that command.

If any help provided by the built-in help text is unclear or incorrect, this should be considered a bug. Please consider opening an issue in the bug tracker.