Running the agent

Claris Connect provides a command line utility to run and manage the agent. The agent typically runs automatically as a service after installation, but you can use these commands for manual management and troubleshooting. To see the available commands, open a terminal window in the installation folder and type agent --help

Command

Description

version

Updates the current application version

update

Updates the configuration file

decrypt string Decrypts credentials for use in the configuration file
encrypt string Encrypts credentials for use in the configuration file
configure key Generates a new configuration file, overwriting the previous file
run Runs the agent, based on the current configuration file
start Starts the agent as a service, based on the current configuration file
stop Stops the currently running agent service

Managing the agent

  • After installation, the agent should automatically establish a connection to Claris Connect and show a confirmation message on the setup page.

  • The agent will maintain this connection and automatically handle communication between Claris Connect and your on-premise data sources.

  • If you need to modify data source connections, you can edit the configuration.yml file in the installation directory.