{"id":16281173,"url":"https://github.com/ismet55555/bieye","last_synced_at":"2025-03-20T01:33:50.675Z","repository":{"id":184641960,"uuid":"670008193","full_name":"ismet55555/bieye","owner":"ismet55555","description":"A blazingly fast rust-based bionic reader for blazingly fast reading within a terminal console 🦀","archived":false,"fork":false,"pushed_at":"2023-11-13T08:51:14.000Z","size":755,"stargazers_count":16,"open_issues_count":8,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-17T21:32:24.840Z","etag":null,"topics":["cli","fast","reading","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ismet55555.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-07-24T05:08:26.000Z","updated_at":"2024-08-16T02:03:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"950a3207-bd61-418a-b7aa-223c8336e666","html_url":"https://github.com/ismet55555/bieye","commit_stats":null,"previous_names":["ismet55555/bieye"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismet55555%2Fbieye","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismet55555%2Fbieye/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismet55555%2Fbieye/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismet55555%2Fbieye/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ismet55555","download_url":"https://codeload.github.com/ismet55555/bieye/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221733338,"owners_count":16871851,"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","fast","reading","rust","terminal"],"created_at":"2024-10-10T19:05:28.432Z","updated_at":"2024-10-27T21:07:02.392Z","avatar_url":"https://github.com/ismet55555.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"350\" alt=\"portfolio_view\" src=\"assets/logo.png\"\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ismet55555/bieye/rust.yml)\n![Crates.io](https://img.shields.io/crates/v/bieye)\n![Crates.io](https://img.shields.io/crates/l/bieye)\n\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\nThis Rust-based CLI tool reads text and returns it back in bionic reading format\nfor blazingly fast loading and even faster reading!\n\nBionic reading is the reading of specially formatted text, allowing for\nfaster reading. This is possible by strategically highlinting pieces\nof text, which tricks the brain of reading without losing content.\n\n**Essentially:** Use this tool to speed up your text reading while using the console\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/demo.gif\" alt=\"test gif\" width=\"90%\" style=\"box-shadow: 0 0 10px 5px rgba(0, 0, 0, 0.5);\"\u003e\n\u003c/p\u003e\n\n## Installation\n\n- **Homebrew**\n\n  ```bash\n  brew install ismet55555/things/bieye\n  ```\n\n- **Snap Store**\n\n  ```bash\n  snap install bieye\n  ```\n\n- **Cargo**\n\n  ```bash\n  cargo install bieye\n  ```\n\n- **Compile From Source**\n\n  ```bash\n  git clone git@github.com:ismet55555/bieye.git\n  cd bieye\n  cargo install --path .\n  ```\n\n## Usage Examples\n\nThe following are a few simple usage examples for `bieye`\n\n```bash\n# Simple text specification\nbieye \"Hello there, how is your day going?\"\n\n# Piping standard out into bieye\ncat README.md | bieye\nman git | bieye\necho \"HELLO! hello hello elo el ...\" | bieye\n\n# Add some output options\ncat quest.md | bieye --color --dim\n```\n\n## CLI Menu\n\n```txt\n$ bieye -h\n\nbieye v0.0.0\n\nThis CLI tool reads text and returns it back in bionic reading format\nfor blazingly fast loading and even faster reading!\n\nExample Usages:\n   bieye \"Keep on reading\"\n   echo \"Read faster, learn more\" | bieye --dim\n   man vim | bieye --dim --color\n\nUsage: bieye [OPTIONS] [TEXT]\n\nArguments:\n  [TEXT]  Capture text from stdin\n\nOptions:\n  -c, --color    Color highlighted text\n  -d, --dim      Dim text not highlighted\n  -h, --help     Print help (see more with '--help')\n  -V, --version  Print version\n```\n\n## Contribution and Development\n\nFeel free to contribute! Here is a super quick start if you are vaguely familiar with [Rust](https://www.rust-lang.org/tools/install).\n\n```bash\n# Setup\ngit clone git@github.com:ismet55555/bieye.git\ncd bieye\ngit checkout -b my-cool-new-branch\ncargo build\n\n# ... work work work ...\n\n# Test run the CLI\ncargo run -- --help\necho \"Just some testing text\" | cargo run --\n\n# Run tests\ncargo test\n\n# Other terminal windows\ncargo install --locked bacon\nbacon --all-features\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fismet55555%2Fbieye","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fismet55555%2Fbieye","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fismet55555%2Fbieye/lists"}