{"id":18795079,"url":"https://github.com/aeosynth/bk","last_synced_at":"2025-04-13T02:21:00.033Z","repository":{"id":40632536,"uuid":"256918155","full_name":"aeosynth/bk","owner":"aeosynth","description":"Terminal Epub reader","archived":false,"fork":false,"pushed_at":"2024-06-09T10:49:32.000Z","size":167,"stargazers_count":292,"open_issues_count":12,"forks_count":24,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-04T04:39:49.340Z","etag":null,"topics":["cli","console","ebook","epub","rust","terminal"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/aeosynth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"ko_fi":"aeosynth"}},"created_at":"2020-04-19T05:01:00.000Z","updated_at":"2025-03-31T12:43:24.000Z","dependencies_parsed_at":"2024-11-07T21:45:46.876Z","dependency_job_id":null,"html_url":"https://github.com/aeosynth/bk","commit_stats":{"total_commits":163,"total_committers":2,"mean_commits":81.5,"dds":0.006134969325153339,"last_synced_commit":"61beded518e759884d72732a068744935c11ea6f"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeosynth%2Fbk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeosynth%2Fbk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeosynth%2Fbk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeosynth%2Fbk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aeosynth","download_url":"https://codeload.github.com/aeosynth/bk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654667,"owners_count":21140340,"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":["cli","console","ebook","epub","rust","terminal"],"created_at":"2024-11-07T21:32:32.221Z","updated_at":"2025-04-13T02:21:00.006Z","avatar_url":"https://github.com/aeosynth.png","language":"Rust","readme":"# bk\nbk is a terminal EPUB reader, written in Rust.\n\n# Features\n- Cross platform - Linux, macOS and Windows support\n- Single binary, instant startup\n- EPUB 2/3 support\n- Vim bindings\n- Incremental search\n- Bookmarks\n\n# Install\nInstall from crates.io:\n\n    cargo install bk\n\nor from github:\n\n    git clone https://github.com/aeosynth/bk\n    cargo install --path bk\n\n# Usage\n\n    Usage: bk [\u003cpath\u003e] [-m] [-t] [-w \u003cwidth\u003e]\n\n    read a book\n\n    Options:\n      --bg              background color (eg 282a36)\n      --fg              foreground color (eg f8f8f2)\n      -m, --meta        print metadata and exit\n      -t, --toc         start with table of contents open\n      -w, --width       characters per line\n      --help            display usage information\n\nRunning `bk` without a path will load the most recent EPUB.\n\nType any function key (eg \u003ckbd\u003eF1\u003c/kbd\u003e) to see the keybinds.\n\nCheck if your terminal supports italics:\n\n    echo -e \"\\e[3mitalic\\e[0m\"\n\n# Comparison\n|   | bk | epr/epy |\n| - | - | - |\n| runtime deps | ❌ | python, curses |\n| wide characters | ✔️ | ❌ |\n| incremental search | ✔️ | ❌ |\n| multi line search | ✔️ | ❌ |\n| regex search | ❌ | ✔️ |\n| links | ✔️ | ❌ |\n| images | ❌ | ✔️ |\n| themes | ✔️ | ✔️ |\n| choose file from history | ❌ | ✔️ |\n| additional formats | ❌ | FictionBook, Mobi, AZW3 |\n| external integration | see 1 | dictionary |\n\n1: you can use the `--meta` switch to use `bk` as a file previewer with eg [nnn](https://github.com/jarun/nnn/)\n\n# Inspiration\n\u003chttps://github.com/wustho/epr\u003e\n","funding_links":["https://ko-fi.com/aeosynth"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeosynth%2Fbk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faeosynth%2Fbk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeosynth%2Fbk/lists"}