Installation

Install Ramadan CLI using npm, yarn, pnpm, bun, or run directly with npx

Installation

Ramadan CLI can be installed globally on your system or run on-demand with npx. Choose the method that works best for your workflow.

Requirements

Ramadan CLI requires Node.js 20 or higher. Check your version with node --version.

Quick Run (No Install)

The fastest way to try Ramadan CLI is with npx:

npx ramadan-cli

This will download and run the latest version without installing anything globally. Perfect for one-time use or trying it out.

Global Installation

For regular use, install Ramadan CLI globally to access it from anywhere in your terminal.

npm

npm install -g ramadan-cli@latest

After global installation, you can use any of the CLI aliases: roza, ramadan, ramzan, ramazan, or ramadan-cli.

Verify Installation

Check that Ramadan CLI is installed correctly:

ramadan-cli --version
# or
roza --version

You should see the version number (e.g., 6.1.0).

Available Aliases

After installation, you can use any of these commands interchangeably:

roza

roza

Shortest and most common

ramadan-cli

ramadan-cli

Full package name

ramadan

ramadan

Simple alternative

ramzan / ramazan

ramzan
# or
ramazan

Regional variations

All aliases run the exact same program. Use whichever feels most natural to you.

Agent Installation

If you’re using Ramadan CLI with AI coding agents, you can install it as a skill package:

npx skills add ahmadawais/ramadan-cli

This makes Ramadan CLI available to your agent for automated tasks.

Update to Latest Version

To update an existing global installation:

npm

npm update -g ramadan-cli

Uninstall

To remove Ramadan CLI from your system:

npm

npm uninstall -g ramadan-cli

This only removes the program. Your saved configuration (location, settings) is stored separately. Use ramadan-cli reset to clear your config before uninstalling.

Installation Troubleshooting

Command not found after installation

If you see command not found: roza after installing:

1. Check your PATH: Global npm packages need to be in your PATH

   npm config get prefix
   

   The bin directory inside this path should be in your PATH.

2. Restart your terminal: Close and reopen your terminal window.

3. Use npx instead: If PATH issues persist, use npx:

   npx ramadan-cli
   

Permission errors on macOS/Linux

If you get EACCES permission errors:

Option 1: Use a Node version manager (recommended)

# Using nvm
nvm install 20
nvm use 20
npm install -g ramadan-cli

Option 2: Fix npm permissions

mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g ramadan-cli

Avoid using sudo: Using sudo npm install -g can cause permission issues later.

Node.js version too old

Ramadan CLI requires Node.js 20 or higher. To upgrade:

Using nvm (recommended):

nvm install 20
nvm use 20
nvm alias default 20

Direct download: Visit nodejs.org and download the LTS version.

Slow installation

If installation is taking too long:

1. Check your internet connection: npm needs to download packages
2. Try a different registry: Some regions have faster mirrors
   npm config set registry https://registry.npmjs.org/
   
3. Clear npm cache:
   npm cache clean --force
   

Platform-Specific Notes

macOS

Recommended setup:

# Install Node.js with Homebrew (if not already installed)
brew install node@20

# Install Ramadan CLI
npm install -g ramadan-cli

The CLI works great with macOS terminal apps like Terminal.app, iTerm2, and Warp.

Linux

Recommended setup:

# Using nvm (recommended)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
source ~/.bashrc
nvm install 20

# Install Ramadan CLI
npm install -g ramadan-cli

Works with all Linux distributions and terminal emulators.

Windows

Recommended setup:

1. Download and install Node.js 20+ from nodejs.org
2. Open PowerShell or Command Prompt
3. Install Ramadan CLI:
   npm install -g ramadan-cli
   

Windows Terminal users: The CLI displays colors and Unicode properly in Windows Terminal, PowerShell, and WSL.

Next Steps

Now that you have Ramadan CLI installed, let’s run it for the first time:

Quick Start Guide

Learn how to run your first command and complete the interactive setup

---

Having issues? Check the troubleshooting section above or open an issue on GitHub.