Link utility commands
configure command
The configure command is required before using any other command.
This command is used to specify the installation type, the OEM integration, and the
user/group. You must specify the correct option for --integration
at a minimum.
--type <native|docker> |
Specify the installation type. Default: native
|
--integration <oem> |
Specify your integration.
|
--license-file |
This option is intended for standalone customer use only. Do not use if you received HCL Link as an embedded solution.
|
--user |
The user to install HCL Link to. This determines which user has ownership of the processes and directories. This must be an already existing user. Default: current user
|
--group |
The group to install HCL Link as. This provides you with flexibility to share HCL Link directories with a group of admins. Default: current group |
install
.
If you notice a mistake after installation, extract the HCL Link package into a
new directory and begin again.install, uninstall, start, and stop commands
The behavior of the
install
, uninstall
, start
,
and stop
commands is similar.
--runtime |
Runtime REST API |
--design-server |
Design Server |
status command
The status command retrieves the status of each HCL Link component. The usage is similar between the native and docker installation types, though the possible states are different.
--runtime |
Runtime REST API |
--design-server |
Design Server |
Possible states
Native
- Not Installed
- Stopped
- Running
- Unknown
Docker
- Not Installed
- Created
- Dead
- Exited
- Paused
- Running
- Restarting
logs command
The logs command prints the primary log of the chosen component. Because the log files may grow to a large size, you should funnel the output of this command into a tool like less for better navigation.
--runtime-app |
Runtime REST API |
--design-server-app |
Design Server – Backend |
--design-server-client |
Design Server – UI |