Getting started
First, make sure you have bat and fzf installed. Lexy requires it for syntax highlighting and searching.
You can use the command lexy --help
to see all available options.
lexy --help
Usage: lexy [OPTIONS] <LANGUAGE>
Display <LANGUAGE> documentation using bat.
<LANGUAGE> refers to the language name or the following options:
- Use "list" to view all available languages.
- Use "update" to force update Lexy.
- Use "modified" to view the last modified date of Lexy.
Options:
--version Show the version and exit.
--help Show this message and exit.
Lexy keeps a local copy of the documentation in $HOME/.config/lexy
, which is created automatically the first time you run Lexy, and it will be updated every 60 days. You can force an update using "update" as <LANGUAGE>
.