Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehwan/bigstr
A command-line tool to make string BIG
https://github.com/ehwan/bigstr
command-line-tool text-processing
Last synced: 10 days ago
JSON representation
A command-line tool to make string BIG
- Host: GitHub
- URL: https://github.com/ehwan/bigstr
- Owner: ehwan
- License: mit
- Created: 2024-06-24T15:59:33.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-06-25T12:43:19.000Z (4 months ago)
- Last Synced: 2024-10-06T07:48:27.713Z (about 1 month ago)
- Topics: command-line-tool, text-processing
- Language: Rust
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BigStr
A command line tool to make string BIG
## Example
```shell
$ echo "BIGSTR" | bigstr -f 'DejaVuSansM Nerd Font' -s 17 --background '=' --offset -0.2
========================================================================================
========================================================================================
========================================================================================
==╭──────────╮===╭──────────╮====╭────────╮===╭─────────╮╭────────────────────────╮=====
==│ ╭─────╮ ╰╮==╰───╮ ╭───╯==╭─╯╭───────╯=╭─╯╭────────╯╰─────╮ ╭─────╮ ╭─────╮╰─╮===
==│ │=====╰╮ │======│ │=====╭╯ ╭╯=========│ │===============│ │=====│ │=====│ │===
==│ │=====╭╯ │======│ │=====│ ╭╯==========│ ╰╮==============│ │=====│ │=====│ │===
==│ ╰─────╯ ╭╯======│ │====╭╯ │===========╰─╮ ╰─────╮========│ │=====│ ╰─────╯ ╭╯===
==│ ╭─────╮ ╰╮======│ │====│ │====╭─────╮==╰─────╮ ╰─╮======│ │=====│ ╭╯====
==│ │=====╰╮ ╰╮=====│ │====╰╮ ╰╮===╰──╮ │========╰─╮ ╰╮=====│ │=====│ ╭────╮ ╰╮====
==│ │======│ │=====│ │=====│ │======│ │==========│ │=====│ │=====│ │====╰─╮╰╮===
==│ │====╭─╯ ╭╯=====│ │=====╰╮ ╰─╮====│ │╭──╮=====╭╯ ╭╯=====│ │=====│ │======│ ╰╮==
==│ ╰────╯ ╭─╯==╭───╯ ╰───╮==╰──╮╰────╯╭─╯╰╮ ╰─────╯╭─╯======│ ╭╯=====│ ╭╯======╰╮ ╰╮=
==╰─────────╯====╰──────────╯=====╰──────╯===╰────────╯========╰─╯======╰─╯========╰──╯=
========================================================================================
========================================================================================
========================================================================================
$ bigstr -f Arial -s 12 -m BigsTR
╭────────╮ ╭─╮ ╭─────────╮ ╭─────────╮
│ ╭─────╮╰╮ ╰─╯ ╰───╮ ╭───╯ │╭───────╮╰╮
│ │ │ │ ╭─╮ ╭─╮ ╭───╮ ╭──╮╭──╮ │ │ ││ ╭╯╭╯
│ ╰─────╯ │ │ │ ╭╯╭╯ ╰─╮ │ │ ╭╯╰──╯ │ │ │╰──────╱─╯
│ ╭──────╮╰╮ │ │ │╭╯ │ │ ╰─╲────╮ │ │ │╭────╮ ╰╮
│ │ │ │ │ │ │╰╮ ╭╯ │ ╭─╱───╮╰╮ │ │ ││ ╰─╮╰╮
│ ╰──────╱─╯ │ │ ╰─╲───╯ │ ╰╮╰───╯╭╯ │ │ ││ ╰╮╰╮
╰────────╯ ╰─╯ ╭─╱───╮ ╭╯ ╰─────╯ ╰─╯ ╰╯ ╰─╯
╰╮╰───╯╭╯
╰─────╯
```
## Usage
```
$ bigstr --help
A command-line tool to make string BIG
Usage: bigstr [OPTIONS] [COMMAND]
Commands:
list show list of available fonts
help Print this message or the help of the given subcommand(s)
Options:
-f, --famliy
A name of font famliy
--font-file
A path to a font file
-m, --message
A message to render, if not specified, read from stdin
-s, --size
The height of the rendered text
[default: 18]
-o, --offset
Each character will be offseted by this value
i.e. -1.0 means the character will be moved 100% of its width to the left,
0.0 means no offset,
1.0 means the character will be moved 100% of its width to the right.
Giving values like -0.5 will make the characters overlap a little. Have Fun!
[default: 0.0]
-t, --threshold
The threshold to determine whether a pixel is foreground or background
[default: 0.5]
-b, --background
The background character
[default: " "]
--mode
The mode to render the text
"round": the rendered text will be rounded
"square": the rendered text will be squared
default is "round"
[default: round]
-a, --aspect-ratio
The aspect ratio of the cursor
The ratio height/width of actual rendered character (e.g. the unicode box drawing characters)
Since we use (mono) character as pixel, the proper aspect ratio should be given to make the image looks good
[default: 2.0]
-w, --width
The maximum width of the rendered image
If a single character cannot be fit into this width, the program will panic
If the given string exceeds this width, it will be wrapped into multiple lines
[default: 80]
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
```