Skip to content

Quick Start

Get started with Rhamaa CLI in 5 minutes.

1. Create Project

rhamaa start MyBlog
cd MyBlog

2. Setup Environment

python -m venv .venv
source .venv/bin/activate  # Linux/Mac
pip install -r requirements.txt

3. List Available Apps

rhamaa startapp --list

4. Install Prebuilt App

rhamaa startapp articles --prebuild articles

5. Configure App

Add to settings.py: 

INSTALLED_APPS = [
    # ... existing apps
    'apps.articles',
]

Run migrations: 

python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser

6. Start Server

python manage.py runserver

Visit http://127.0.0.1:8000/admin/

What's Next?

Add More Apps

Explore other available apps:

# Add user management
rhamaa startapp users --prebuild users

# Add IoT capabilities
rhamaa startapp iot --prebuild mqtt

# Add LMS functionality
rhamaa startapp lms --prebuild lms

Get App Information

Learn more about any app before installing:

rhamaa startapp --list
# Then open the app repo linked in the table for details

Registry Commands

The standalone registry command group is deprecated. Use:

rhamaa startapp --list

Common Workflows

Starting a Blog Project

rhamaa start MyBlog
cd MyBlog
rhamaa startapp articles --prebuild articles
# Configure and run migrations

Starting an IoT Project

rhamaa start IoTDashboard
cd IoTDashboard
rhamaa startapp iot --prebuild mqtt
rhamaa startapp users --prebuild users
# Configure MQTT settings and run migrations

Starting an Educational Platform

rhamaa start EduPlatform
cd EduPlatform
rhamaa startapp lms --prebuild lms
rhamaa startapp users --prebuild users
# Configure LMS settings and run migrations

Tips for Success

Project Structure

Rhamaa CLI creates apps in the apps/ directory. This keeps your project organized and follows Django best practices.

Force Installation

If you need to reinstall a prebuilt app into the same folder, use the --force flag: 

rhamaa startapp articles --prebuild articles --force

Check Project Type

Rhamaa CLI automatically detects if you're in a Wagtail project before allowing app installation.

Troubleshooting

App Already Exists

If you see "App already exists" during prebuilt installation, use the --force flag to overwrite:

rhamaa startapp articles --prebuild articles --force

Not a Wagtail Project

Make sure you're in the root directory of your Wagtail project (where manage.py is located).

Download Issues

If downloads fail, check your internet connection and try again. The CLI will show detailed error messages.

Next Steps