From fba198c1e0d20eac4a2af151608827057d4f36d5 Mon Sep 17 00:00:00 2001 From: Robert Walter <26892280+RobWalt@users.noreply.github.com> Date: Mon, 2 May 2022 23:46:25 +0200 Subject: [PATCH] Add documentation for `hx --health` (#2357) --- book/src/install.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/book/src/install.md b/book/src/install.md index 34d8b651c..cbd2c0280 100644 --- a/book/src/install.md +++ b/book/src/install.md @@ -66,6 +66,15 @@ via the `HELIX_RUNTIME` environment variable. |windows |`xcopy runtime %AppData%/helix/runtime`| |linux/macos|`ln -s $PWD/runtime ~/.config/helix/runtime` +## Finishing up the installation + +To make sure everything is set up as expected you should finally run the helix healthcheck via +``` +hx --health +``` +For more information on the information displayed in the healthcheck results refer to [Healthcheck](https://github.com/helix-editor/helix/wiki/Healthcheck). + + ## Building tree-sitter grammars Tree-sitter grammars must be fetched and compiled if not pre-packaged.