Healthcheck

Healthcheck

To make sure your Helix installation is set up the way you intented it to be, make sure to run

hx --health

The output is split into two sections:

Helix configuration section

The first part of the healthcheck output consists of the locations of all the important files currently used by Helix. These include:

• the config file
• the language file
• the log file
• the runtime directory

Language configuration section

The second part of the healthcheck output consists of a table which shows the current status of each language supported by Helix. There are several features which can be configured for each language. The list of the features are:

• LSP (Language Server Protocol)
• DAP (Debug Adapter Protocol)
• Highlight (Syntax highlighting)
• TextObject (jump to functions, classes, etc. details here)
• Indent (details here)

The color of the entry in the table indicates the current state of the feature:

• red: The feature cannot be found on the system
• yellow: The feature isn't configured currently
• green: The feature was found on the system

Additionally you can run:

hx --health [LANG]

to get a more detailed overview for the configuration status of a specific language. Additionally to the features listed above, the output contains:

• the location of the LSP binary (if available)
• the location of the DAP binary (if available)