{"id":13897173,"url":"https://github.com/tuxcanfly/litter","last_synced_at":"2025-10-28T21:30:36.273Z","repository":{"id":189063966,"uuid":"679957660","full_name":"tuxcanfly/litter","owner":"tuxcanfly","description":"A lightweight terminal-based read-only browser","archived":false,"fork":false,"pushed_at":"2023-10-02T20:38:03.000Z","size":3611,"stargazers_count":21,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T18:22:21.649Z","etag":null,"topics":["browser","cli","terminal","tui","w3m"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tuxcanfly.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-08-18T02:35:35.000Z","updated_at":"2024-11-10T15:20:50.000Z","dependencies_parsed_at":"2023-08-19T13:03:10.067Z","dependency_job_id":"7c79ff45-285f-4e77-83a4-40fe0950669f","html_url":"https://github.com/tuxcanfly/litter","commit_stats":null,"previous_names":["tuxcanfly/runtpy","tuxcanfly/litter"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuxcanfly%2Flitter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuxcanfly%2Flitter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuxcanfly%2Flitter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuxcanfly%2Flitter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tuxcanfly","download_url":"https://codeload.github.com/tuxcanfly/litter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238720433,"owners_count":19519350,"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":["browser","cli","terminal","tui","w3m"],"created_at":"2024-08-06T18:03:23.841Z","updated_at":"2025-10-28T21:30:30.799Z","avatar_url":"https://github.com/tuxcanfly.png","language":"Python","funding_links":[],"categories":["Python","\u003ca name=\"browser\"\u003e\u003c/a\u003eWeb browser"],"sub_categories":[],"readme":"# Litter\n\nLitter is a minimalistic, terminal-based read-only browser. It allows users to\nbrowse the web without the bloat and distractions of modern web browsers. This\nproject is designed for lightweight browsing and reading, with an emphasis on\nthe content.\n\n![Demo](./demo.gif)\n\n\n## Features:\n\n- Terminal-based browsing for a distraction-free reading experience.\n- URL navigation and search functionality using DuckDuckGo Lite by default.\n- Basic navigation options like forward and backward.\n- Customizable keymap to adjust the controls to your liking.\n- Lightweight bookmarking system.\n- Help overlay with keybindings.\n- Readability integration to clean and simplify webpage content.\n\n## Dependencies:\n\n- `requests`: For making HTTP requests.\n- `urwid`: For the terminal-based UI.\n- `readability`: For cleaning and simplifying webpage content.\n- `BeautifulSoup4`: For parsing HTML.\n\n## Installation:\n\n1. Clone the repository:\n\n```\ngit clone https://github.com/tuxcanfly/litter.git\n```\n\n2. Navigate to the project directory:\n\n```\ncd litter\n```\n\n3. Install the required dependencies:\n\n```\npip install requests urwid readability-lxml beautifulsoup4\n```\n\n## Usage:\n\nSimply run the `litter.py` script:\n\n```\npython litter.py\n```\n\nUpon launch, the default starting page is \"https://example.com\". You can\nnavigate to different URLs, search for terms using DuckDuckGo Lite, bookmark\nyour favorite pages, and much more.\n\n### Keybindings:\n\n- `q`, `Q`, `esc`: Quit the browser.\n- `i`: Jump to the URL bar.\n- `enter`: Load the URL or search for a keyword.\n- `backspace`: Go back to the previous page.\n- `b`: Bookmark the current URL.\n- `?`: Toggle help screen.\n\nYou can also customize the keybindings by modifying the `keymap.json` file.\n\n## Customizing:\n\n### Key Map:\n\nThe key bindings for various actions can be modified by adjusting the `keymap.json` file.\n\nFor example, to change the quit key to `ctrl q`, you can modify the file like:\n\n```json\n{\n    \"quit\": [\"ctrl q\"],\n    ...\n}\n```\n\n### Themes:\n\nThe color scheme of the interface can be modified by adjusting the `palette` in the main function.\n\n## Contributing:\n\nFeel free to open issues, suggest enhancements, or submit pull requests. All contributions are welcome!\n\n## License:\n\nMIT\n\n## Credits:\n\n[Runt](https://github.com/FreeFull/runt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftuxcanfly%2Flitter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftuxcanfly%2Flitter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftuxcanfly%2Flitter/lists"}