Hub commandline#

The Cegal Hub binary includes commandline options for performing a variety of tasks including the running of an agent and server.

To get an overview of the Cegal Hub you can explore the commands available on the binary

cegalhub --help

Additionally the commandline interface (CLI) includes commands for

  • inspecting and managing the installation and configuration

  • obtaining Cegal Keystone information such as access tokens and the tenant id the user belongs to

  • managing a Windows Service (with the Windows version of the Cegal Hub binary)

  • opening the documentation in a local browser

  • performing queries against a running Cegal Hub Server and making requests of a Cegal Hub Agent

This last item is known as the Hub commandline client CLI and is discussed below.

Hub Client CLI#

The Cegal Hub client commandline interface (CLI) allows a user to perform operations against a running Cegal Hub Server.

Explore the commandline client command


cegalhub client --help
Client options#

option (flag)


activate, a

Activate a running Cegal Hub Server (required when Cegal Hub Server is running in Server mode)

verify-health, vh

Verify the health and status of a running Cegal Hub Server

query-server, qs

Query for information about the running Cegal Hub Server instance

query-connectors, qc

Query for information about Cegal Hub connectors connected to a running Cegal Hub Server

agent-file-list, afl

List files in a given directory and or sub directories. Options are available to filter the search

agent-file-download, afd

Download file(s) from a Cegal Hub Agent.

agent-file-upload, afu

Upload file(s) to a Cegal Hub Agent.

agent-launch-profile, alp

Launch an application profile from a Cegal Hub Agent

help, h

Shows a list of commands or help for one command

The above shows the subcommands to the client command. Use the Cegal Hub Client CLI directly to explore these commands further.

Setting up a remote configuration profile#

To save typing connection details such as the host, port and TLS settings when connecting to a remote Hub Server it is possible to configure and persist a remote profile.

Using the command ‘cegalhub i c’ you can get or set the remote config options. To set the config use the set-remote command and supply the flags for the address, the port number, tls, and optional connector-join-token and if you want to allow public connections. Alternatively the remote config can be set in the ‘remote_connection_settings.json’ in the user’s app data.


For example to set a remote configuration

cegalhub installation config set-remote --port=443 --tls

To check what your remote configuration is set to

cegalhub installation config get-remote

The remote configuration can be utilized when launching a Cegal Hub Agent

cegalhub agent --remote

Similary the remote configuration can be utilized when using the Cegal Hub Client CLI

cegalhub client verify-health --remote