Before You Start

Choose Your Patform

Below you will see instructions on installing Serge on your system with the necessary dependencies. If you prefer to keep things isolated, you can also install Serge as a Docker container.

Select Preferred Version

Serge source code is available on GitHub. Code in master branch is considered the latest version; stable releases are marked with release tags.

Installing Serge on Windows Unix Mac OS

Serge can run on any OS with Perl 5.10 or higher. UnixMac OS systems have Perl already installed. On Windows, we recommend installing Strawberry Perl.

You can check your Perl version by running this command:

perl -v

Step 1. Create a Directory for Serge

Serge can work in any directory. So create a new directory for Serge application files. For example:

mkdir ~/serge mkdir C:\Serge

Step 2. Download the Stable ReleaseLatest Code Snapshot

cd ~/serge wget<version>.zip -O serge-master<version>.zip unzip serge-master<version>.zip unlink serge-master<version>.zip cd serge-master<version>

Download<version>.zip and unpack it to C:\Serge.

Step 3. Install Dependencies

Some Perl modules that you're about to install in step 3.2 require compiling binaries from sources. Run your package manager to install build essentials and library headers. For example, on Ubuntu/Debian this will be:

sudo apt-get -qq update sudo apt-get -qq -y install build-essential libssl-dev libexpat-dev

Installing/upgrading Perl dependencies is done with the help of cpanm package manager, which needs to be installed with the following command:

sudo cpan App::cpanminus Once you have it installed, run the following commands: cd ~/serge/C:\Serge\serge-master<version> sudo cpanm --installdeps .

Step 4. Make Serge Available from Any Directory

Add C:\Serge\serge-master<version>\bin directory to your PATH environment variable in Windows settings (make sure to remove the path to the previous version of Serge if it was there). After that you will need to close and open a new shell window so that it would pick up the changes.

Create a symlink to serge binary:

sudo ln -s ~/serge/serge-master<version>/bin/serge /usr/local/bin/serge

Step 5. Verify the Installation

Run this command to see command-line help from Serge:


Step 6. Generate HTML Help

If you're installing Serge on your development machine, you can take advantage of using HTML help that will open in your browser. Run the following command to generate the HTML version of the help for Serge commands:

serge gendocs

To test the result, run:

serge help

This will open a help page in the browser.

Now, get started with Serge workflow and configuration →