About   |   Demo   |   Features   |   Technologies   |   Requirements   |   Installation   |   Documentation   |   License

Lexy is a lightweight CLI tool that fetches programming tutorials from Learn X in Y Minutes directly into your terminal. Quickly search, learn, and reference code examples without leaving your workflow.

Lexy saves a local copy of the documentation, so you can access it even when you're offline. It also provides syntax highlighting using bat.

This project would not be possible without the amazing work of the Learn X in Y Minutes community. A huge thanks to all contributors for making high-quality learning resources freely available!

✔️ Check documentation from "Learn X in Y minutes" directly from the terminal
✔️ Syntax highlighting using bat
✔️ Local copy to speed up the process and avoid too many requests to the "Learn X in Y minutes" server
✔️ Auto-update every 60 days

The following tools were used in this project:

• Click
• Typer
• Beautifulsoup

Before starting 🏁, you need to have bat installed.

git clone https://github.com/antoniorodr/lexy

cd lexy

pip install .

brew tap antoniorodr/lexy
brew install antoniorodr/lexy/lexy

uv tool run git+https://github.com/antoniorodr/lexy --help

First, make sure you have bat installed. Lexy requires it for syntax highlighting.

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.

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>.

This project is under license from MIT. For more details, see the LICENSE file.

Made with ❤️ by Antonio Rodriguez

Back to top