Skip to content

Installation

Prerequisites

  • Python 3.7+
  • pip package manager

Install from PyPI

pip install rhamaa

Verify Installation

rhamaa --help

You should see the Rhamaa CLI logo and available commands.

Install Wagtail (Required for projects)

pip install wagtail

Development Installation

git clone https://github.com/RhamaaCMS/RhamaaCLI.git
cd RhamaaCLI
pip install -e .

Verify Installation

After installation, verify that Rhamaa CLI is working:

rhamaa --help

You should see the Rhamaa CLI logo and help information.

Installing Wagtail (Required)

Rhamaa CLI requires Wagtail to create new projects. Install it globally:

pip install wagtail

Or install it in your virtual environment where you plan to work.

Virtual Environment Setup

It's recommended to use virtual environments for your projects:

# Create a new virtual environment
python -m venv myproject-env

# Activate it
# On Linux/Mac:
source myproject-env/bin/activate
# On Windows:
# myproject-env\Scripts\activate

# Install Rhamaa CLI and Wagtail
pip install rhamaa wagtail

Troubleshooting

Permission Errors

If you encounter permission errors on Linux/Mac:

pip install --user rhamaa

Command Not Found

If rhamaa command is not found after installation:

  1. Check if the installation directory is in your PATH
  2. Try using python -m rhamaa instead
  3. Reinstall with --user flag

Python Version Issues

Rhamaa CLI requires Python 3.7+. If you have multiple Python versions:

python3 -m pip install rhamaa

Next Steps

Once installed, proceed to the Quick Start Guide to create your first project.

Updating

To update to the latest version:

pip install --upgrade rhamaa

To check your current version:

pip show rhamaa