A blazingly fast rust-based bionic reader for blazingly fast reading within a terminal console πŸ¦€

Overview

portfolio_view


This Rust-based CLI tool reads text and returns it back in bionic reading format for blazingly fast loading and even faster reading!

Bionic reading is the reading of specially formatted text, allowing for faster reading. This is possible by strategically highlinting pieces of text, which tricks the brain of reading without losing content.

Essentially: Use this tool to speed up your text reading while using the console

test gif

Installation

  • Homebrew

    brew install ismet55555/things/bieye
  • Snap Store

    snap install bieye
  • Cargo

    cargo install bieye
  • Compile From Source

    git clone [email protected]:ismet55555/bieye.git
    cd bieye
    cargo install --path .

Usage Examples

The following are a few simple usage examples for bieye

# Simple text specification
bieye "Hello there, how is your day going?"

# Piping standard out into bieye
cat README.md | bieye
man git | bieye
echo "HELLO! hello hello elo el ..." | bieye

# Add some output options
cat quest.md | bieye --color --dim

CLI Menu

$ bieye -h

bieye v0.0.0

This CLI tool reads text and returns it back in bionic reading format
for blazingly fast loading and even faster reading!

Usage: bieye [OPTIONS] [TEXT]

Arguments:
  [TEXT]  Capture text from stdin

Options:
  -c, --color    Color highlighted text
  -d, --dim      Dim text not highlighted
  -h, --help     Print help (see more with '--help')
  -V, --version  Print version

Contribution and Development

Feel free to contribute! Here is a super quick start if you are vaguely familiar with Rust.

# Setup
git clone [email protected]:ismet55555/bieye.git
cd bieye
git checkout -b my-cool-new-branch
cargo build

# ... work work work ...

# Test run it
cargo run -- --help
echo "Just some testing text" | cargo run --

# Other terminal windows
cargo install --locked bacon
bacon --all-features
You might also like...
A TUI feed reader for RSS, Atom, and (aspirationally) Podcasts
A TUI feed reader for RSS, Atom, and (aspirationally) Podcasts

moccasin A TUI feed reader for RSS, Atom, and (eventually) Podcasts. VIM keybindings. Ranger-inspired interface. Configurable. Installation cargo inst

πŸ¦€οΈatos for linux by rust - A partial replacement for Apple's atos tool for converting addresses within a binary file to symbols.

atosl-rs πŸ¦€οΈ atos for linux by rust - A partial replacement for Apple's atos tool for converting addresses within a binary file to symbols. tested on

Console progress bar for Rust
Console progress bar for Rust

Terminal progress bar for Rust Console progress bar for Rust Inspired from pb, support and tested on MacOS, Linux and Windows Documentation Examples s

An ascii webcam in your console, written as a way of learning rust.

asciicam An ascii webcam in your console, written as a way of learning rust. asciicam picture of me holding a basketball usage only linux is supported

A command line tool for people of transgender experience to replace their deadname within a Git repo.

chowndn (Change Owner from Dead Name) A command line tool for people of transgender experience to replace their dead name within a Git repo. See chown

Transpile CommonMark Markdown to Typst, from within Typst!
Transpile CommonMark Markdown to Typst, from within Typst!

#set document(title: "cmarker.typ") #set page(numbering: "1", number-align: center) #set text(lang: "en") #align(center, text(weight: 700, 1.75em)[cma

A versatile and dynamic music bot designed to elevate the musical experience within Discord servers.

Masayoshi Masayoshi is a discord music bot written in Rust for making a great experience within Discord servers with support to Youtube, SoundCloud, S

🌈 Brings back colour console to Win64 for Garry's Mod SRCDS
🌈 Brings back colour console to Win64 for Garry's Mod SRCDS

🌈 gmsv_concolormsg This module for Garry's Mod fixes x86-64 Windows 64-bit SRCDS not displaying colours. Why does it do that? Who knows! But it's eas

Simple console input macros with the goal of being implemented in the standard library.

Simple console input macros with the goal of being implemented in the standard library.

Comments
  • Updated readme to correct the folder name

    Updated readme to correct the folder name

    Looks like the folder name in the readme after cloning isn't accurate (it mentions bioread instead of bieye), i updated the folder name to bieye instead of bioread.

    opened by msbn21 0
  • Fix Waiting for Input when Simply Running bieye on its Own

    Fix Waiting for Input when Simply Running bieye on its Own

    Currently when running bieye on its own without any arguments or piping, it will hang and wait for user to enter some text.

    This is not desirable behavior. without any input, it should simply display the -h or --help help menu

    opened by ismet55555 0
Releases(v0.2.0)
  • v0.2.0(Aug 1, 2023)

    What's Changed

    • Initial Work by @ismet55555 in https://github.com/ismet55555/bieye/pull/1
    • Adding demo gif to README.md by @ismet55555 in https://github.com/ismet55555/bieye/pull/2
    • Updated readme to correct the folder name by @msbn21 in https://github.com/ismet55555/bieye/pull/3
    • Concurrency Past a Number of Words by @ismet55555 in https://github.com/ismet55555/bieye/pull/4
    • Removed backticks from title by @ismet55555 in https://github.com/ismet55555/bieye/pull/5
    • Bump version to 0.2.0 by @ismet55555 in https://github.com/ismet55555/bieye/pull/6
    • Create GitHub Action by @ismet55555 in https://github.com/ismet55555/bieye/pull/7

    New Contributors

    • @ismet55555 made their first contribution in https://github.com/ismet55555/bieye/pull/1
    • @msbn21 made their first contribution in https://github.com/ismet55555/bieye/pull/3

    Full Changelog: https://github.com/ismet55555/bieye/commits/v0.2.0

    Source code(tar.gz)
    Source code(zip)
Owner
Ismet Handzic
Gettin it done
Ismet Handzic
πŸ“° A terminal feed reader with a fancy ui

tuifeed Developed by @veeso Current version: 0.1.1 (17/11/2021) ~ A terminal news feed reader with a fancy ui ~ tuifeed About tuifeed ?? Features ?? G

Christian Visintin 55 Jan 5, 2023
Warp is a blazingly fast, Rust-based terminal that makes you and your team more productive at running, debugging, and deploying code and infrastructure.

Warp is a blazingly fast, Rust-based terminal that makes you and your team more productive at running, debugging, and deploying code and infrastructure.

Warp 10.4k Jan 4, 2023
A command-line utility which aligns a block of text within the terminal (or a specified number of columns), written in Rust.

align: a command line utility for aligning text. ⭐ Overview Aligns text within the terminal (or a specified number of columns). The text is treated as

Khalil Ouali 6 Aug 11, 2023
Rust Crate that allows to do interruptions in console. Will be implemented to functional terminal customization kit.

termpause Rust Crate that allows to do interruptions in console. Will be implemented to functional terminal customization kit. Usage Add this in your

Just Said 4 Sep 21, 2022
πŸ“š flow state reading in the terminal

fsrx ?? (f)low (s)tate (r)eading e(x)change – flow state reading in the terminal Inspired by (but not affiliated with) Renato Casutt and his revolutio

colby thomas 276 Dec 14, 2022
πŸ“š flow state reading in the terminal

fsrx ??(f)low (s)tate (r)eading e(x)change – flow state reading in the terminal Inspired by (but not affiliated with) Renato Casutt and his revolution

Colby Thomas 296 Oct 26, 2023
Print your git contributions in your terminal, blazingly fast

Takoyaki Blazingly fast git contribution graph in your terminal Features βœ”οΈ Customizable βœ”οΈ Plugins to support a bunch of cloud based git repositories

kyeboard 13 Feb 6, 2023
Get your github contributions right in your terminal, blazingly fast!

GitColorScripts Get your github contributions right in your terminal! Installation Install via yay yay -S gitcolorscripts Install manually Download t

VoidCupboard 56 Jul 12, 2023
Rust low-level minimalist APNG writer and PNG reader with just a few dependencies with all possible formats coverage (including HDR).

project Wiki https://github.com/js29a/micro_png/wiki at glance use micro_png::*; fn main() { // load an image let image = read_png("tmp/test.

jacek SQ6KBQ 8 Aug 30, 2023
Configurable, extensible, interactive line reader

linefeed linefeed is a configurable, concurrent, extensible, interactive input reader for Unix terminals and Windows console. API Documentation linefe

Murarth 176 Jan 3, 2023