runix-cli 1.4.0

A CLI tool for ASCII art in your terminal
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# runix

`runix` is a blazing fast CLI tool that allows you to cast ASCII spells directly in your terminal. Whether you want to generate high-quality ASCII word art or render classic ASCII illustrations, `runix` has you covered.

## Installation

```bash
cargo install runix-cli
```

## Usage

Generate standard word art:
```bash
runix "Hello"
```

Render illustrations using the `--art` (or `-a`) flag:
```bash
runix wolf -a
runix ghost --art
runix spaceship -a
```

---

## How It Works: Built-in + AI + Smart Caching
Once downloaded the user need to set the local <a href="https://console.groq.com/keys">groq</a> api key.

```
runix --set-key <your api key>
```
`runix` uses an intelligent multi-layer pipeline to give you instant art every time:

1. **Built-in Library**: Comes pre-compiled with **80+ classic ASCII illustrations** for instant nanosecond lookups.
2. **Groq AI Generation**: If a word isn't in the library, `runix` casts an AI spell using Groq to generate custom ASCII art on the fly.
3. **Generate Once, Use Many (Local Cache)**: Any AI-generated art is automatically saved to your local disk (`~/.runix/cache.json`). Subsequent calls load instantly from your local cache with zero network wait!
4. **Key Security**: The key is securely stored locally  (`~/.runix/config.json`) in this file.
---

## The runix Art Library

`runix` comes pre-compiled with a curated library of over 80+ classic ASCII art pieces, sourced from the public domain. 

Here are all the available built-in spells you can cast:

### Animals (26)
`cat`, `kitten`, `dog`, `cow`, `unicorn`, `turtle`, `butterfly`, `whale`, `elephant`, `wolf`, `bear`, `fish`, `shark`, `bird`, `eagle`, `penguin`, `snail`, `spider`, `rabbit`, `possum`, `kangaroo`, `bat`, `owl`, `snake`, `dragon`, `scorpion`

### Nature (12)
`sun`, `moon`, `mountain`, `tree` (or `pine`), `flower`, `wave`, `rose`, `snowman`, `leaf`, `mushroom`, `cactus`

### Celestial (7)
`planet` (or `earth`), `saturn`, `star`, `shooting-star`, `ufo`, `comet`

### Objects (41)
`house`, `castle`, `rocket`, `car`, `train`, `ship`, `plane`, `helicopter`, `sword`, `crown`, `heart`, `skull`, `shield`, `key`, `lock`, `book`, `clock`, `hourglass`, `trophy`, `lantern` (or `lamp`), `coffee` (or `cup`), `pizza`, `bomb`, `fire` (or `flame`), `lightning` (or `bolt`, `thunder`), `anchor`, `diamond`, `ghost`, `robot`, `alien`, `snowflake`, `dna` (or `helix`), `atom`, `guitar` (or `music`), `note`, `chess` (or `pawn`), `target`, `maze`, `compass`, `flag`, `heart2` (or `love`), `ship2` (or `galleon`), `crown2` (or `king`)

### People / Fantasy (4)
`wizard`, `angel`, `santa`, `pirate`

### Scenes (4)
`ocean` (or `sea`), `forest`, `campfire`

### Sci-Fi (2)
`enterprise` (or `starship`)