azaan-cli
v1.0.0
Published
A lightweight, beautiful, and interactive CLI to check Azaan times anywhere in the world.
Maintainers
Readme
Azaan CLI 🕌
A lightweight, beautiful, and interactive CLI to check Azaan times anywhere in the world right from your terminal. Built for humans and status bars.

Install
Install globally via npm:
npm install -g azaan-cliUsage
On your first run, the CLI will interactively ask you for your City and Country, and save it in your config.
azaanOverride City (One-off): If you want to quickly check another city without changing your configuration:
azaan "London"
azaan "New York"Status Bar / Scripts (--status): Output a single-line string of the next prayer and countdown. Perfect for tmux, Waybar, or Polybar.
azaan --status
# Example Output: Next prayer is Maghrib in 45 mins and 12 seconds at 05:55 PMConfigure & Reset: To change your default saved city or calculation method later:
azaan configTo completely clear your local configuration:
azaan resetDesktop Notifications (Zero Setup)
The azaan-cli comes with a built-in lightweight background daemon for notifications. There is zero setup required.

The moment you run azaan in your terminal, the background process starts automatically. It will quietly check the time in the background and send you a native desktop notification 10 minutes before every Azaan, and exactly at the time of the Azaan.
Managing the Daemon
You don't need to do anything to start it, but if you want manual control, you can use the daemon commands:
# Check if the daemon is running
azaan daemon status
# Stop the background notifications
azaan daemon stop
# Start the daemon manually
azaan daemon startShoutout 🙌
A massive thank you and shoutout to Ahmad Awais for building ramadan-cli, which served as the primary inspiration and foundation that led to the creation of Azaan CLI.
Powered By
- Aladhan Prayer Times API
commander&@clack/prompts
