An open API service indexing awesome lists of open source software.

https://github.com/y-hatano-github/candle

CLI command to display candle fire effect written in Golang
https://github.com/y-hatano-github/candle

animation cli cmd command command-line cui fire-effect go-cli golang joke joke-app joke-application joke-cli joke-command terminal

Last synced: about 1 month ago
JSON representation

CLI command to display candle fire effect written in Golang

Awesome Lists containing this project

README

          

![candle](candle.gif)

# ๐Ÿ•ฏ๏ธ Candle
This is a joke command that displays a candle-like fire effect in your terminal.
It renders a retro-style flame animation that serves absolutely no purposeโ€”other than looking cool.
Requires a terminal with 256-color support.

# โš™๏ธ Features
- ๐Ÿ”ฅ Retro-style flame rendering.
- โณ Configurable display duration.
- ๐ŸŽจ 256-color terminal required.
- ๐Ÿ–ฅ๏ธ Cross-platform binaries (Windows, macOS, Linux)

# ๐Ÿ’พ Download
๐Ÿ‘‰ Get the latest release here:
https://github.com/y-hatano-github/candle/releases/latest

# Quick start
## ๐Ÿง Linux
```bash
wget https://github.com/y-hatano-github/candle/releases/latest/download/candle_linux_amd64.tar.gz
tar -xzvf candle_linux_amd64.tar.gz
mv candle /usr/local/bin/
candle
```

## ๐ŸŽ macOS
```bash
curl -LO https://github.com/y-hatano-github/candle/releases/latest/download/candle_darwin_amd64.tar.gz
tar -xzvf candle_darwin_amd64.tar.gz
sudo mv candle /usr/local/bin/
candle
```

## ๐ŸชŸ Windows
```powershell
Invoke-WebRequest -OutFile candle_windows_amd64.tar.gz https://github.com/y-hatano-github/candle/releases/latest/download/candle_windows_amd64.tar.gz
tar -xzvf candle_windows_amd64.tar.gz
.\candle.exe
```

## ๐Ÿ“˜ Usage
```
Usage: candle [DURATIONTIME]

Positional arguments:
DURATIONTIME [Optional]duration time

Options:
--help, -h display this help and exit
```

Example: display the candle flame for three seconds
```
candle 3
```
## โŒจ๏ธ Key bindings
[esc / CTRL+C] - exit