{"id":29873688,"url":"https://github.com/antoniorodr/lexy","last_synced_at":"2026-04-19T10:03:56.242Z","repository":{"id":290716626,"uuid":"974337200","full_name":"antoniorodr/lexy","owner":"antoniorodr","description":"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.","archived":false,"fork":false,"pushed_at":"2026-04-13T19:54:10.000Z","size":7200,"stargazers_count":102,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-04-13T21:33:56.111Z","etag":null,"topics":["cli","code","documentation","languages-and-tools","learn","learn-x-in-y-minutes","python","terminal","terminal-based","tutorials"],"latest_commit_sha":null,"homepage":"https://antoniorodr.github.io/lexy/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/antoniorodr.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":"antoniorodr"}},"created_at":"2025-04-28T16:09:02.000Z","updated_at":"2026-04-13T19:54:15.000Z","dependencies_parsed_at":"2025-06-11T14:30:31.436Z","dependency_job_id":"b41e2501-442a-45c5-8ad4-e3cfdf1eace9","html_url":"https://github.com/antoniorodr/lexy","commit_stats":null,"previous_names":["antoniorodr/lexy"],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/antoniorodr/lexy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniorodr%2Flexy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniorodr%2Flexy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniorodr%2Flexy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniorodr%2Flexy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/antoniorodr","download_url":"https://codeload.github.com/antoniorodr/lexy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniorodr%2Flexy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32002361,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T20:23:30.271Z","status":"online","status_checked_at":"2026-04-19T02:00:07.110Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","code","documentation","languages-and-tools","learn","learn-x-in-y-minutes","python","terminal","terminal-based","tutorials"],"created_at":"2025-07-30T23:02:26.303Z","updated_at":"2026-04-19T10:03:56.228Z","avatar_url":"https://github.com/antoniorodr.png","language":"HTML","funding_links":["https://github.com/sponsors/antoniorodr"],"categories":["Python","\u003ca name=\"learning\"\u003e\u003c/a\u003eLearning and didactic tools"],"sub_categories":[],"readme":"# `lexy`\n\n\u003e [!caution]\n\u003e **Status:** Under development\n\n## ℹ️ About\n\n**Lexy** is a lightweight Python CLI that brings tutorials from [Learn X in Y Minutes](https://learnxinyminutes.com) straight into your terminal. It is designed for quick lookup, learning, and reference without breaking your workflow.\n\nLexy keeps a local cache of the documentation so you can browse content offline, preview it with syntax highlighting through [bat](https://github.com/sharkdp/bat), and search available languages with [fzf](https://github.com/junegunn/fzf).\n\nFull documentation is available at [antoniorodr.github.io/lexy](https://antoniorodr.github.io/lexy/).\n\n\u003e[!tip]\n\u003eIf you use Neovim, check out the [lexy.nvim plugin](https://github.com/antoniorodr/lexy.nvim)\n\n## 🎬 Demo\n\n![Lexy demo](./assets/lexy.gif)\n\n## ✨ Features\n\n- Read Learn X in Y Minutes tutorials directly from the terminal\n- Browse cached documentation offline after the first fetch\n- Preview syntax-highlighted content with `bat`\n- Search available languages with `fzf`\n- Refresh the local cache on demand with `lexy update`\n- Check when the cache was last updated with `lexy modified`\n- Customize the `fzf` layout and colors through `config.toml`\n\n## 🛠️ Technologies\n\nThe project is built with:\n\n- [Python](https://www.python.org/)\n- [Typer](https://typer.tiangolo.com/)\n- [Click](https://click.palletsprojects.com/en/stable/)\n- [Beautiful Soup](https://pypi.org/project/beautifulsoup4/)\n- [requests](https://pypi.org/project/requests/)\n- [tomlkit](https://pypi.org/project/tomlkit/)\n- [fzf](https://github.com/junegunn/fzf)\n- [bat](https://github.com/sharkdp/bat)\n\n## 📋 Requirements\n\nBefore starting, make sure the required tools and dependencies are installed on your machine:\n\n```bash\npython3.13 --version\nfzf --version\nbat --version\n```\n\nLexy requires Python 3.13 or newer, plus `fzf` for searching and `bat` for syntax-highlighted previews.\n\nOn some Linux distributions, installing `bat` with `apt` provides the executable as `batcat` instead of `bat`. In that case, follow the [official bat instructions](https://github.com/sharkdp/bat?tab=readme-ov-file#on-ubuntu-using-apt) to create the required symlink, since a shell alias is not visible to the Python subprocess Lexy uses.\n\n## 📦 Installation\n\n### Manual installation\n\n```bash\ngit clone https://github.com/antoniorodr/lexy\ncd lexy\npip install .\n```\n\n### Homebrew installation\n\n```bash\nbrew tap antoniorodr/lexy\nbrew install antoniorodr/lexy/lexy\n```\n\n### Installation with [uv](https://docs.astral.sh/uv/)\n\n```bash\nuv tool install git+https://github.com/antoniorodr/lexy\n```\n\n### AUR installation\n\n```bash\nyay -S lexy\n```\n\n## 🚀 Getting Started\n\nOnce installed, try the core commands:\n\n```bash\nlexy list\nlexy python\nlexy update\nlexy modified\n```\n\nUse `lexy list` to browse available languages, pass a language name like `lexy python` to open a tutorial, use `lexy update` to refresh the local cache, and `lexy modified` to check when the cache was last updated.\n\nLexy stores its local documentation cache and configuration in `$HOME/.config/lexy`. The cache is created automatically on first run and refreshed automatically every 60 days.\n\nIf you want to customize the `fzf` interface, create a `config.toml` file in the Lexy config directory and override only the values you want to change.\n\nFor full usage details and theming examples, see the [documentation site](https://antoniorodr.github.io/lexy/).\n\n## ❤️ Do you like my work?\n\nIf you find the project useful, you can support the author here:\n\n[![GitHub Sponsor](https://img.shields.io/badge/Sponsor_on_GitHub-30363D?logo=github\u0026style=for-the-badge)](https://github.com/sponsors/antoniorodr)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoniorodr%2Flexy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantoniorodr%2Flexy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoniorodr%2Flexy/lists"}