runi

<h1 align="center">
  runi
</h1>

<p align="center">
  a CLI tool to generate unicode fonts
</p>

<div align="center">
  <a href="https://x.com/cryptograthor">
    <img src="https://img.shields.io/badge/made_by_cryptograthor-black?style=flat&logo=undertale&logoColor=hotpink" />
  </a>
  <a href="https://github.com/thor314/runi/actions">
    <img src="https://github.com/thor314/runi/actions/workflows/ci.yml/badge.svg" />
  </a>
  <a href="https://crates.io/crates/runi">
    <img src="https://img.shields.io/crates/v/runi.svg" />
  </a>
  </div>

`runi` is a portmanteau of Rust and Unicode. It allows you to generate unicode-fonts, instead of having to visit websites like https://lingojam.com.

The following unicode fonts are supported:
- superscript:       ᵃᵇᶜᵈᵉᶠᵍʰⁱʲᵏˡᵐⁿᵒᵖqʳˢᵗᵘᵛʷˣʸᶻ
- subscript:         ₐbcdₑfgₕᵢⱼₖₗₘₙₒₚqᵣₛₜᵤᵥwₓyz
- script:            𝒶𝒷𝒸𝒹ℯ𝒻𝓰𝒽𝒾𝒿𝓀𝓁𝓂𝓃ℴ𝓅𝓆𝓇𝓈𝓉𝓊𝓋𝓌𝓍𝓎𝓏
- script-bold:       𝓪𝓫𝓬𝓭𝓮𝓯𝓰𝓱𝓲𝓳𝓴𝓵𝓶𝓷𝓸𝓹𝓺𝓻𝓼𝓽𝓾𝓿𝔀𝔁𝔂𝔃
- fullwidth:         ａｂｃｄｅｆｇｈｉｊｋｌｍｎｏｐｑｒｓｔｕｖｗｘｙｚ
- gothic:            𝔞𝔟𝔠𝔡𝔢𝔣𝔤𝔥𝔦𝔧𝔨𝔩𝔪𝔫𝔬𝔭𝔮𝔯𝔰𝔱𝔲𝔳𝔴𝔵𝔶𝔷
- gothic-bold:       𝖆𝖇𝖈𝖉𝖊𝖋𝖌𝖍𝖎𝖏𝖐𝖑𝖒𝖓𝖔𝖕𝖖𝖗𝖘𝖙𝖚𝖛𝖜𝖝𝖞𝖟
- sans:              𝖺𝖻𝖼𝖽𝖾𝖿𝗀𝗁𝗂𝗃𝗄𝗅𝗆𝗇𝗈𝗉𝗊𝗋𝗌𝗍𝗎𝗏𝗐𝗑𝗒𝗓
- sans-italic:       𝘢𝘣𝘤𝘥𝘦𝘧𝘨𝘩𝘪𝘫𝘬𝘭𝘮𝘯𝘰𝘱𝘲𝘳𝘴𝘵𝘶𝘷𝘸𝘹𝘺𝘻
- monospace:         𝚊𝚋𝚌𝚍𝚎𝚏𝚐𝚑𝚒𝚓𝚔𝚕𝚖𝚗𝚘𝚙𝚚𝚛𝚜𝚝𝚞𝚟𝚠𝚡𝚢𝚣
- sans-bold:         𝗮𝗯𝗰𝗱𝗲𝗳𝗴𝗵𝗶𝗷𝗸𝗹𝗺𝗻𝗼𝗽𝗾𝗿𝘀𝘁𝘂𝘃𝘄𝘅𝘆𝘇
- sans-bold-italic: 𝙖𝙗𝙘𝙙𝙚𝙛𝙜𝙝𝙞𝙟𝙠𝙡𝙢𝙣𝙤𝙥𝙦𝙧𝙨𝙩𝙪𝙫𝙬𝙭𝙮𝙯
- serif-bold:        𝐚𝐛𝐜𝐝𝐞𝐟𝐠𝐡𝐢𝐣𝐤𝐥𝐦𝐧𝐨𝐩𝐪𝐫𝐬𝐭𝐮𝐯𝐰𝐱𝐲𝐳
- small-caps:        ᴀʙᴄᴅᴇꜰɢʜɪᴊᴋʟᴍɴᴏᴘǫʀꜱᴛᴜᴠᴡxʏᴢ
- circled:           ⓐⓑⓒⓓⓔⓕⓖⓗⓘⓙⓚⓛⓜⓝⓞⓟⓠⓡⓢⓣⓤⓥⓦⓧⓨⓩ
- circled-negative: 🅐🅑🅒🅓🅔🅕🅖🅗🅘🅙🅚🅛🅜🅝🅞🅟🅠🅡🅢🅣🅤🅥🅦🅧🅨🅩
- squared:           🄰🄱🄲🄳🄴🄵🄶🄷🄸🄹🄺🄻🄼🄽🄾🄿🅀🅁🅂🅃🅄🅅🅆🅇🅈🅉
- squared-negative: 🅰🅱🅲🅳🅴🅵🅶🅷🅸🅹🅺🅻🅼🅽🅾🅿🆀🆁🆂🆃🆄🆅🆆🆇🆈🆉
- double-struck:     𝕒𝕓𝕔𝕕𝕖𝕗𝕘𝕙𝕚𝕛𝕜𝕝𝕞𝕟𝕠𝕡𝕢𝕣𝕤𝕥𝕦𝕧𝕨𝕩𝕪𝕫
- inverted:          ɐqɔpǝɟƃɥıɾʞןɯuodbɹsʇnʌʍxʎz
- reversed:          AdↄbɘꟻgHijklmᴎoqpᴙꙅTUvwxYz
- faux-cyrillic:     аъсdэfБЂіјкlмиорqѓѕтцvшхЎz

This might be useful if you work with mathematical formulas or just enjoy using alternate unicode text font styles.

## Usage
Provide any of the subcommands listed above, and any string:

```sh
$ runi double-struck abcdefghijklmnopqrstuvwxyz\\
𝕒𝕓𝕔𝕕𝕖𝕗𝕘𝕙𝕚𝕛𝕜𝕝𝕞𝕟𝕠𝕡𝕢𝕣𝕤𝕥𝕦𝕧𝕨𝕩𝕪𝕫
```

## Generate shell completions for your shell:
Generate completions for your shell. Choices are: bash, elvish, fish, powershell, zsh.

```sh
runi --completions $YOUR_SHELL > runi_completions.sh
source runi_completions.sh
```

## Install
```sh
cargo install runi
# or if you have cargo-binstall, even faster https://github.com/cargo-bins/cargo-binstall
cargo binstall runi
```

## License
Licensed under your option of either:
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

## Project created with flags:
This project was generated with [Thor's cargo generate template](https://github.com/thor314/tk-cargo-generate/) with flags:
- project-name: runi
- description:  a CLI tool to generate unicode fonts
- authors:      Thor Kampefner <thorck@pm.me>
- crate_name:   runi
- crate_type:   bin
- os-arch:      linux-x86_64
- username:     Thor Kampefner
- within_cargo: false
- is_init:      false
- now:          2024-02-26
- bin or lib:   bin 
- advanced:     advanced 
- cli:          cli 
- license:      license 
- ci:           ci 
- itests:       itests 
- benches:      benches 
- async:       
- server: