{"id":28642041,"url":"https://github.com/WANDEX/twitchez","last_synced_at":"2025-06-12T22:03:16.288Z","repository":{"id":46333034,"uuid":"446840410","full_name":"WANDEX/twitchez","owner":"WANDEX","description":"TUI client for Amazon's twitch.tv with thumbnails","archived":false,"fork":false,"pushed_at":"2024-10-05T20:35:06.000Z","size":398,"stargazers_count":19,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-12T17:12:34.378Z","etag":null,"topics":["console","curses","dmenu","fzf","gplv3","mpv","python","streamlink","terminal","thumbnails","tui","twitch","twitchez","twitchtv","ueberzug","ueberzugpp"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WANDEX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-11T13:50:36.000Z","updated_at":"2025-05-02T02:09:35.000Z","dependencies_parsed_at":"2022-09-20T22:12:03.119Z","dependency_job_id":null,"html_url":"https://github.com/WANDEX/twitchez","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/WANDEX/twitchez","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WANDEX%2Ftwitchez","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WANDEX%2Ftwitchez/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WANDEX%2Ftwitchez/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WANDEX%2Ftwitchez/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WANDEX","download_url":"https://codeload.github.com/WANDEX/twitchez/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WANDEX%2Ftwitchez/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259539025,"owners_count":22873332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["console","curses","dmenu","fzf","gplv3","mpv","python","streamlink","terminal","thumbnails","tui","twitch","twitchez","twitchtv","ueberzug","ueberzugpp"],"created_at":"2025-06-12T22:01:52.026Z","updated_at":"2025-06-12T22:03:16.280Z","avatar_url":"https://github.com/WANDEX.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# twitchez\n\n\u003ca href=\"https://betterttv.com/emotes/shared/search?query=hackermans\"\u003e\n\u003cimg src=\"https://cdn.betterttv.net/emote/5b490e73cf46791f8491f6f4/3x\"\nalign=\"right\" title=\"HACKERMANS\" alt=\"The famous HACKERMANS twitch.tv emote\"\nstyle=\"width: 112px; height: 112px\"\u003e\n\u003c/a\u003e\n\n![PyPI - Status](https://img.shields.io/pypi/status/twitchez?style=flat-square)\n![PyPI](https://img.shields.io/pypi/v/twitchez?style=flat-square)\n![PyPI - License](https://img.shields.io/pypi/l/twitchez?style=flat-square)\n\u003ca href=\"https://pypistats.org/packages/twitchez\"\u003e\n![PyPI - Downloads](https://img.shields.io/pypi/dm/twitchez?style=flat-square)\n\u003c/a\u003e\n\ntwitchez - TUI client for twitch.tv with thumbnails support that works right in your terminal.\n\nSupport of rendering images by the terminal is not required, ueberzugpp will handle that.\\\nYou may ask -- **\"Is this magic?\"** -- Well **YES**, the black magic! Welcome to the club!\n\nSince **v0.0.7** twitchez supports **ueberzugpp** -- this expands list of supported platforms:\\\n**linux / macOS / windows / freeBSD / X11 / Wayland /** any terminal with **SIXEL** support e.g.\n[WezTerm](https://github.com/wez/wezterm)\n\n### Leave a star to show interest in further development of the project ⭐️\n\nhttps://user-images.githubusercontent.com/15724752/152787467-dc2a8871-43e5-4530-94b1-e14383c8b18e.mp4\n\n## Features\n* Explore twitch without leaving your terminal\n* Flexible configuration via user config (including custom cmd)\n* Completely keyboard driven workflow\n    * Zero mouse interaction. `F1 / ?` for help about key mappings\n    * Redefine keys and hint chars for your keyboard layout\n    * Link hints similar as in (Vimium, Surfingkeys, etc.)\n    * Interactive select of one entry from all\n([fzf](https://github.com/junegunn/fzf),\n[dmenu](https://tools.suckless.org/dmenu/),\nor any other program via custom cmd)\n* Bookmarks \u0026 Tabs (add, delete, next/prev, jump to tab by name)\n    * Following live channels\n    * Streams per category\n    * Videos per channel (archive/past broadcasts, clips, highlights, uploads)\n* Open video/stream url in external video player\n([streamlink](https://github.com/streamlink/streamlink),\n[mpv](https://github.com/mpv-player/mpv),\nor any other program via custom cmd)\n    * Three independent user cmd and keys to open url as (stream, video, extra)\n    * Copy url to clipboard\n    * Open chat url in default browser or via custom cmd\n* Thumbnails are drawn by the [ueberzugpp](https://github.com/jstkdng/ueberzugpp) (optional dependency)\n\n## Configuration\nLook inside `twitchez/config/` dir to see all available settings, those are defaults.\\\n**Do not change default config files**, create new in the user config dir: `config.conf`, `keys.conf`.\\\nThe default user config dir is `$XDG_CONFIG_HOME/twitchez/`, or `$HOME/.config/twitchez/` by default.\\\nSettings from default config files are used as fallback for settings you haven't changed in your user config.\n\n## Install\n### Pip\nInstall [twitchez](https://pypi.org/project/twitchez/) via [pip](https://pip.pypa.io/en/stable/)\ninto user-wide environment:\n```\n$ pip3 install --user twitchez\n```\nor system-wide environment:\n```\n# pip3 install twitchez\n```\nTo update, add the `--upgrade` or `-U` option.\n\n#### Install ueberzugpp to display thumbnails (Optional)\nIf [ueberzugpp](https://github.com/jstkdng/ueberzugpp?tab=readme-ov-file#install)\nis not installed **text mode without thumbnails** will be used.\n\nYou also can [build from source](https://github.com/jstkdng/ueberzugpp?tab=readme-ov-file#build-from-source)\nand install **build dir** e.g. `# sudo cmake --install build`\n\n## Troubleshooting\n##### If you installed ueberzugpp but still not see thumbnails:\n* override default ueberzugpp output **via twitchez user config** *(check **default.conf** it has example)*\n* check available **output** options in **ueberzugpp** via `$ ueberzugpp layer --help`\n* x11 and/or wayland (may not be available if disabled in compilation) -- build ueberzugpp from source\n* if you want to draw via e.g. sixel, make sure that your terminal have such capability\n* [WezTerm](https://github.com/wez/wezterm) has sixel support, try to launch twitchez in it\n\n##### If thumbnails partially overlap underlying text (it is very font dependent):\n* set width/height modifier in user config\n* adjust your terminal font size by +1 etc\n* try different terminal font\n\n## License\n[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWANDEX%2Ftwitchez","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWANDEX%2Ftwitchez","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWANDEX%2Ftwitchez/lists"}