uwuifyy

Crates.io	uwuifyy
lib.rs	uwuifyy
version	0.3.0
source	src
created_at	2022-01-28 03:58:05.490718
updated_at	2022-02-09 23:40:52.139419
description	A robust, customizable, blazingly-fast, efficient and easy-to-use command line application to uwu'ify your text!
homepage
repository	https://github.com/sgoudham/uwuifyy
max_upload_size
id	522912
size	276,748

Hammy (sgoudham)

documentation

README

uwuifyy

A robust, customizable, blazingly-fast, efficient and easy-to-use command line application to uwu'ify your text!

Logo Credits: Jade Nelson

uwuifyy

About

Have you ever wanted to uwu'ify text and large files at blazing fast speeds? Well! You came to the right place! uwuifyy allows you to uwu'ify text and files from within your own terminal in an extremely fast manner!

Features

BLAZINGLY FAST (Check out -> Benchmarks)
Seeded by default to allow for reproducible results
Excludes URL's & Emails
UwU'ify files available locally on disk
Completely customisable modifiers

Installation

Homebrew

For macOS users, installation through Homebrew is recommended.

$ brew tap sgoudham/tap
$ brew install uwuifyy

Binaries

Binaries for Windows, macOS & Linux are available with every single release

Windows

Download either uwuifyy-x86_64-pc-windows-msvc.zip or uwuifyy-x86_64-pc-windows-gnu.zip
Extract into \bin folder at C:\your\path\here\

C:
|__your
    |__path
        |__here
            |__bin
                |__uwuifyy.exe

Set uwuifyy.exe in your path to access it globally

$ setx path "%path%;C:\your\path\here\bin"

Refresh command line and verify installation

$ uwuifyy --help

Linux \ macOS

Download uwuifyy-x86_64-unknown-linux-gnu.tar.gz or uwuifyy-x86_64-unknown-linux-musl.tar.gz or uwuifyy-x86_64-apple-darwin.tar.gz
Extract into your local directory

# Linux
$ tar -xf uwuifyy-x86_64-unknown-linux-gnu.tar.gz
$ tar -xf uwuifyy-x86_64-unknown-linux-musl.tar.gz

# macOS
$ tar -xf uwuifyy-x86_64-apple-darwin.tar.gz

Move into ~/bin

# Create ~/bin if it does not exist
$ mkdir -p ~/bin
$ mv uwuifyy ~/bin

Set permissions for executable

$ chmod 755 ~/bin/uwuifyy

Update PATH to use globally

# Linux
$ echo 'export PATH=~/bin:$PATH' >> ~/.bashrc 
$ source ~/.bashrc

# macOS
$ echo 'export PATH=~/bin:$PATH' >> ~/.bash_profile
$ source ~/.bash_profile

Verify installation

$ uwuifyy --version
uwuifyy 0.3.0

Rust \ Cargo

Alternatively, if using Rust's package manager, Cargo, all that is needed is

$ cargo install uwuifyy

If you do not have Cargo available on your machine, you can download it as part of Rust here

Usage

$ uwuifyy --help

USAGE:
    uwuifyy.exe [OPTIONS] <--text <TEXT>|--infile <FILE>>

OPTIONS:
    -t, --text <TEXT>         The text to uwu'ify
    -i, --infile <FILE>       The file to uwu'ify
    -o, --outfile <FILE>      The file to output uwu'ified text
        --ascii-only          The uwu'ified text will only include ASCII faces
        --unicode-only        The uwu'ified text will only include UTF-8 faces
    -r, --random              The flag to enable randomized uwu'ified text
    -w, --words <VALUE>       The modifier to determine how many words to be uwu'ified [default: 1]
    -f, --faces <VALUE>       The modifier for uwu faces e.g hello -> hewwo [default: 0.05]
    -a, --actions <VALUE>     The modifier for actions e.g *shuffles over* [default: 0.125]
    -s, --stutters <VALUE>    The modifier for stutters e.g b-baka! [default: 0.225]
    -h, --help                Print help information
    -V, --version             Print version information