Healthcheck - helix-editor/helix GitHub Wiki

Health Check

To ensure your Helix installation is configured correctly, run:

hx --health

The output is divided into two sections:

1. Helix Configuration Section

health_config

The first section displays the locations of key files currently used by Helix, including:

  • The configuration file
  • The language file
  • The log file
  • The runtime directories
  • The system clipboard provider (if available)

2. Language Configuration Section

image

The second section presents a table showing the status of each supported language. Each language has several configurable features:

  • Language servers
  • Debug adapter
  • Formatter
  • Syntax highlighting
  • Text object (e.g., jump to functions, classes; details here)
  • Indentation (details here)

Table entry colors indicate feature status:

  • Red: Feature not found on the system
  • Yellow: Feature not configured
  • Green: Feature found and configured

For detailed language-specific information, run:

hx --health [LANG]

This provides additional details beyond the features listed above, including:

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