Administration guide to Lucent Sky AVM CLI Core

2024/8/5 |

This article covers the installation, configuration, and uninstallation of Lucent Sky AVM CLI.

This article is about the cross-platform CLI built with .NET, also referred to as CLI Core. For the corresponding article about the CLI built with .NET Framework, view the following article in the Lucent Sky Knowledge Base:
Administration guide to Lucent Sky AVM CLI

In this article, you will learn how to:

  • Install Lucent Sky AVM CLI
  • Configure Lucent Sky AVM CLI
  • Update Lucent Sky AVM CLI
  • Uninstall Lucent Sky AVM CLI

At the end, you will be able to install, configure, and uninstall Lucent Sky AVM CLI.

System Requirements

Processor, memory, and hard disk space requirements:

  • Processor: 1.6 GHz processor
  • Memory: 1 GB
  • Hard disk space: 200 MB

Lucent Sky AVM CLI can be installed on the following operating systems:

  • Windows
  • macOS
  • Linux

Lucent Sky AVM CLI is bundled with its own .NET Runtime.

Install Lucent Sky AVM CLI

Lucent Sky AVM CLI provides user and system level setups. The user level setup does not require Administrator or root privileges and installs the CLI to a directory under the user's home directory. The system level setup requires Administrator or root privileges and installs the CLI to a system directory so that it is available to all users in the system.

Lucent Sky AVM CLI can also be installed to other locations.

Windows

User level setup

  1. Create the directory %LOCALAPPDATA%\Programs\CLEAR CLI if it does not already exist.
  2. Extract the content of the Lucent Sky AVM CLI setup file to %LOCALAPPDATA%\Programs\CLEAR CLI.

System level setup

  1. Create the directory C:\Program Files\Lucent Sky\CLEAR CLI if it does not already exist.
  2. Extract the content of the Lucent Sky AVM CLI setup file to C:\Program Files\Lucent Sky\CLEAR CLI.

macOS

User level setup

  1. Create the directory $HOME/Applications/CLEAR CLI if it does not already exist.
  2. Extract the content of the Lucent Sky AVM CLI setup file to $HOME/Applications/CLEAR CLI.

System level setup

  1. Create the directory /Applications/CLEAR CLI if it does not already exist.
  2. Extract the content of the Lucent Sky AVM CLI setup file to /Applications/CLEAR CLI.

Linux

User level setup

  1. Create the directory $HOME/clear-cli if it does not already exist.
  2. Extract the content of the Lucent Sky AVM CLI setup file to $HOME/clear-cli.

System level setup

  1. Create the directory /opt/clear-cli if it does not already exist.
  2. Extract the content of the Lucent Sky AVM CLI setup file to /opt/clear-cli.

Configure Lucent Sky AVM CLI

The CLI needs to be configured to use a remote CLEAR Engine instance. This can be done either with the config interface or by editing the configuration file.

Scriptable configuration

  1. Open PowerShell and enter the following command:

     # Replace <InstanceFqdn> with the FQDN or IP address of the CLEAR Engine instance
 $InstanceFqdn = "<InstanceFqdn>"
 ./SkyAnalyzer.Interface.Cli --Interface config --Method set --Value "endpoint = ${InstanceFqdn}:5759"

Configuration file

  1. Navigate to the install directory of the CLI.
  2. Open appsettings.json with a text editor.
  3. Update the value of the <endpoint/address> element to the address of the remote CLEAR Engine instance.

In the default TCP endpoint configuration, the communication between CLEAR Engine and the CLI is not secure. To learn more about enabling Transport Layer Security for CLEAR Engine and the CLI, view the following article in the Lucent Sky Knowledge Base:
Configure Transport Layer Security

Update Lucent Sky AVM CLI

  1. To update Lucent Sky AVM CLI, uninstall the current version from the system, and install the new version.

Uninstall Lucent Sky AVM CLI

  1. Delete the directory where Lucent Sky AVM CLI is installed.