Skip to content

Latest commit

 

History

28 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌙 Tasmiyah-CLI

A beautiful, fast terminal greeting that prints Bismillah and other Islamic phrases — written in Rust.

Built with Rust License: MIT Platform CI Release Crates.io

tasmiyah-cli output: a centered BISMILLAH ASCII banner with the Basmala in Arabic, its transliteration, and English translation


✨ Overview

tasmiyah-cli is a tiny terminal utility — in the spirit of neofetch, cowsay, and fortune — that prints بِسْمِ ٱللَّٰهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ ("In the name of Allah, the Most Gracious, the Most Merciful") every time you open your terminal.

  • 🪶 Fast — single static binary, ~1–5 ms startup.
  • 🎨 Three layouts — centered ASCII logo (default), classic unicode box, or minimal text.
  • 🌍 Twelve phrases — Basmala, Alhamdulillah, SubhanAllah, Allahu Akbar, and more, several with matching ASCII logos.
  • 🌈 Themes — gold, ocean, rose, or mono palettes, plus per-element custom colors.
  • ⚙️ Config file — set your style, theme, and colors once in ~/.config/tasmiyah/config.toml.
  • 🧩 Cross-platform — Linux, macOS (Apple Silicon + Intel), and Windows.
  • 🚦 Script-safe — auto-detects pipes and disables colors; honors NO_COLOR and TERM=dumb.

📦 Install

Pick one channel.

Cargo (any platform with Rust)

cargo install tasmiyah-cli

Drops the binary into ~/.cargo/bin/ (already on your PATH if you used rustup).

Homebrew (macOS / Linux)

brew install bhantsi/tap/tasmiyah-cli

Prebuilt binary (no toolchain required)

Grab the archive for your platform from the Releases page, verify the .sha256, extract, and drop tasmiyah on your PATH:

# Linux x86_64 — static musl build, works on any distro
curl -L https://github.com/bhantsi/tasmiyah-cli/releases/latest/download/tasmiyah-x86_64-unknown-linux-musl.tar.gz \
  | tar -xz
sudo install -m 755 tasmiyah /usr/local/bin/tasmiyah

Archives are published for:

Platform Targets
Linux x86_64-unknown-linux-gnu, x86_64-unknown-linux-musl, aarch64-unknown-linux-musl
macOS aarch64-apple-darwin, x86_64-apple-darwin (both native)
Windows x86_64-pc-windows-msvc

🚀 Usage

tasmiyah                              # default: Bismillah banner
tasmiyah --translation                # add transliteration + English
tasmiyah --random                     # random phrase from the library
tasmiyah --style classic              # the v0.1 unicode-box layout
tasmiyah --style minimal              # plain text — ideal for shell prompts
tasmiyah --theme ocean                # try a different palette
tasmiyah --no-color                   # disable ANSI colors
tasmiyah --help                       # show every flag

Make it yours with ~/.config/tasmiyah/config.toml:

style = "centered"
theme = "ocean"
translation = true

[colors]
border = "#d4af37"

Add one line to your shell rc to greet you on every new session:

# ~/.bashrc, ~/.zshrc, etc.
command -v tasmiyah >/dev/null 2>&1 && tasmiyah

📖 Full documentation: see the User Guide for the flag-by-flag reference, recipes, shell integration for every major shell (bash, zsh, fish, PowerShell, Nushell), environment variables, the full phrase library, and troubleshooting.


⬆️ Upgrade

tasmiyah prints a short footer once a new version lands on crates.io. Upgrade through the same channel you installed from:

cargo install tasmiyah-cli                            # Cargo
brew update && brew upgrade bhantsi/tap/tasmiyah-cli  # Homebrew

For the prebuilt binary, re-download the latest archive — the install command above also works as an upgrade (it overwrites in place).

Silence the update footer with export NO_UPDATE_NOTIFIER=1.


🛠️ Build from source

git clone https://github.com/bhantsi/tasmiyah-cli.git
cd tasmiyah-cli
cargo build --release
./target/release/tasmiyah

Run the test suite and lints:

cargo test                                  # unit + integration tests
cargo fmt --all -- --check                  # formatting
cargo clippy --all-targets -- -D warnings   # lints

🤝 Contributing

Issues and PRs are welcome — new phrases, bug reports, packaging help, or new platform support. Please run cargo fmt and cargo clippy before opening a PR; CI enforces both.

Maintainers: the release process is documented in docs/RELEASING.md.


📜 License

MIT © bhantsi

May this small tool be a reminder to start every task with His name. Bismillāh. 🌙

About

A beautiful, fast terminal greeting that prints Bismillah and other Islamic phrases — written in Rust

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages