Skip to content

Commit

Permalink
Add documentation for hx --health (#2357)
Browse files Browse the repository at this point in the history
  • Loading branch information
RobWalt authored May 2, 2022
1 parent ac2ea80 commit fba198c
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions book/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit fba198c

Please sign in to comment.