{"id":49971531,"url":"https://github.com/right9code/githubbrowser.koplugin","last_synced_at":"2026-05-21T11:01:32.743Z","repository":{"id":358432416,"uuid":"1239055251","full_name":"right9code/githubbrowser.koplugin","owner":"right9code","description":"A comprehensive GitHub client for KOReader","archived":false,"fork":false,"pushed_at":"2026-05-17T10:32:29.000Z","size":1013,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-18T08:53:43.196Z","etag":null,"topics":["git","github","koreader","koreader-plugin","koreader-plugins"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/right9code.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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-14T18:04:42.000Z","updated_at":"2026-05-17T10:29:30.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/right9code/githubbrowser.koplugin","commit_stats":null,"previous_names":["right9code/githubbrowser.koplugin"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/right9code/githubbrowser.koplugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/right9code%2Fgithubbrowser.koplugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/right9code%2Fgithubbrowser.koplugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/right9code%2Fgithubbrowser.koplugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/right9code%2Fgithubbrowser.koplugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/right9code","download_url":"https://codeload.github.com/right9code/githubbrowser.koplugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/right9code%2Fgithubbrowser.koplugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33209394,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-19T07:54:09.561Z","status":"ssl_error","status_checked_at":"2026-05-19T07:54:08.508Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["git","github","koreader","koreader-plugin","koreader-plugins"],"created_at":"2026-05-18T08:35:39.596Z","updated_at":"2026-05-21T11:01:32.728Z","avatar_url":"https://github.com/right9code.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Github Browser Plugin for KOReader\n| Home Screen | Repository Browser |\n|:-------------------------:|:-------------------------:|\n| ![](screenshot_home.png) | ![](screenshot_repo.png) |\n\nA plugin for KOReader that lets you browse GitHub repositories, view code, and download files — all directly from your e-reader.\n\n## ✨ Features\n- **🔓 Public Repos**: Browse any public GitHub repository without authentication.\n- **🔐 Private Repos**: Access private repositories using GitHub Personal Access Tokens.\n- **📂 File Browser**: Navigate directories, view text/code files, and download documents.\n- **✏️ Edit \u0026 Commit**: Edit files and commit changes directly from your device.\n- **🔑 Multi-Token**: Manage multiple GitHub tokens, set defaults, and assign per-repo tokens.\n- **📌 Pin \u0026 Bookmark**: Pin frequently used repos to the home screen and bookmark favorites.\n- **📜 History**: Track recently visited repositories with configurable history limits.\n- **🎯 Gesture Support**: Assign a gesture shortcut to launch the plugin instantly.\n\n## 🛠️ Installation\n\n1. Copy the `githubbrowser.koplugin` folder to your KOReader `plugins/` directory:\n   - **Kobo**: `/mnt/onboard/.adds/koreader/plugins/`\n   - **Kindle**: `/mnt/us/koreader/plugins/`\n   - **Android**: Wherever your KOReader data directory is located.\n   - **Desktop (AppImage)**: `~/.config/koreader/plugins/`\n2. Restart KOReader.\n3. The plugin will appear in the **Search** menu (4th column in the top menu).\n\n## 📱 Usage Guide\n\n### Getting Started\nOpen the plugin from the KOReader top menu under **Search \u003e Github Browser**:\n1. **Browse public repo...**: Enter `owner/repo` or a full GitHub URL to browse any public repository.\n2. **Browse private repo...**: Same as above, but you'll be prompted to select a token for authentication.\n\n### Token Management\nTo access private repositories or perform write operations (edit, create, delete files):\n1. Go to **Settings \u003e Manage GitHub Tokens**.\n2. Add a token manually, or import multiple tokens from a `.txt` file.\n   - **File Format:** The text file must contain exactly **one token per line**:\n     ```text\n     github_pat_11ABCD...\n     github_pat_22EFGH...\n     ```\n   - **Tip:** Use **Import Tokens (File Picker)** to browse for your `.txt` file visually.\n   - **Fallback:** If the File Picker crashes on your device (common on some Kobo firmware), use **Import Tokens (Type Path)** and simply enter the path to the file (e.g. `/mnt/onboard/token.txt`).\n3. Set a default token, or assign specific tokens to individual repositories.\n\n\u003e **How to get a GitHub token**: Visit [github.com/settings/tokens](https://github.com/settings/tokens) and create a Personal Access Token with `repo` scope.\n\n### Repository View\nOnce inside a repository:\n- **Tap** a folder to navigate into it.\n- **Tap** a file to view its contents (text files) or download it (binary files).\n- **Long-press** a file/folder for additional actions (delete, download).\n- Use **Bookmark**, **Pin**, and **Change Token** options at the top of the repo view.\n\n### Gesture Shortcut\nYou can assign a gesture to open Github Browser directly:\n1. Go to KOReader **Settings \u003e Gestures**.\n2. Find **Github Browser** in the action list.\n3. Assign any gesture (tap zone, swipe, etc.) to it.\n\n## ⚙️ Settings\n| Setting | Description |\n| :--- | :--- |\n| **Manage GitHub Tokens** | Add, rename, delete, or import tokens. Set a default token. |\n| **Download Folder** | Choose where downloaded files are saved (uses KOReader's folder picker). |\n| **Device Name** | Shown in commit messages when editing files. |\n| **Max History Entries** | Limit how many recent repos are tracked (default: 20). |\n| **Clear History / Bookmarks** | Remove all history entries or bookmarks at once. |\n\n## 📁 File Structure\n```\ngithubbrowser.koplugin/\n├── _meta.lua      # Plugin metadata (name, version, author)\n├── main.lua       # Entry point, menu \u0026 gesture registration\n├── api.lua        # GitHub REST API client\n├── browser.lua    # Full UI (home, bookmarks, history, settings, repo browser)\n└── settings.lua   # Persistent settings management\n```\n\n---\n**Author**: right9code  \n**Version**: 1.0  \n**License**: [Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)](https://creativecommons.org/licenses/by-nc/4.0/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fright9code%2Fgithubbrowser.koplugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fright9code%2Fgithubbrowser.koplugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fright9code%2Fgithubbrowser.koplugin/lists"}