The Horilla Setup CLI is a lightweight, cross-platform command-line tool designed to streamline the initialization, migration, upgrade, and dependency management processes across the Horilla ecosystem β including HRMS v1, HRMS v2, and the newly released Horilla CRM.
It automates repetitive setup tasks like environment preparation, Git cloning, dependency installation, and migration handling β ensuring a smooth, consistent workflow for developers and deployment teams.
β Quick project setup for HRMS (v1 & v2) and CRM β Version-aware migrations including HRMS v1 β v2 upgrade β Automated dependency installation from requirements.txt β Seamless project upgrades via Git pull β Cross-platform support (Windows, Linux, macOS) β Single command workflow for setup, migration, and updates
pip install horillasetupIf youβre improving or modifying the tool:
git clone https://github.com/horilla-opensource/setup.git cd horilla-ctl pip install -e .
-einstalls the package in editable mode, so changes take effect instantly.
Show all available commands:
horillasetup --helphorillasetup build hrms-v1horillasetup build hrms-v2horillasetup build crmThe build command will:
- Clone the correct Horilla repo (branch-specific)
- Copy project files into the working directory
- Install Python dependencies
- Provide environment setup instructions
horillasetup migrate hrms-v1horillasetup migrate hrms-v2horillasetup migrate crmMigration steps include:
- Running
makemigrations - Applying migrations
- Collecting static files
Pull latest code updates from Git:
horillasetup upgrade hrms-v1horillasetup upgrade hrms-v2horillasetup upgrade crmTo migrate an existing v1 database into v2:
horillasetup migrate hrms-v2 --existingThis performs:
- Safe clearing of old migration entries
- Faked compatibility migrations
- Full v2 migration + static collection
horillasetup install-depsInstalls all packages from requirements.txt.
# Build a fresh CRM project horillasetup build crm # Run CRM migrations horillasetup migrate crm # Upgrade project later horillasetup upgrade crm- π Plugin-based scaffolding for new Horilla modules
- π Automated version & dependency conflict detection
- π¦ Project template generator
- π§° Extended DevOps tools integration