Installation

How to install the Cheerp toolchain on your favourite operating system

The first step to using Cheerp is to install the Cheerp toolchain.

Command Line Notation

Throughout this documentation, we’ll show some commands used in the terminal. Lines that you should enter in a terminal all start with $. You don’t need to type the $ character; it’s the command line prompt shown to indicate the start of each command. Lines that don’t start with $ typically show the output of the previous command.

Installing Cheerp on Linux

Ubuntu

Releases

we offer both stable and nightly builds, but since our stable build is at this time a few years old, we recommend using nightly

Use our nightly build PPA

(or alternatively our stable build PPA)

$ sudo add-apt-repository ppa:leaningtech-dev/cheerp-nightly-ppa
$ sudo apt-get update
$ sudo apt-get install cheerp-core

being ahead of our supported LTS builds

if you encounter a “the repo does not have a Release file” error your Ubuntu release is most likely newer than our latest build. In this case you will need to manually edit the .sources file following the steps below.

open the .sources file for the PPA release, which is located at:

/etc/apt/sources.list.d/leaningtech-dev-ubuntu-cheerp-nightly-ppa-<codename>.sources

With <codename> being replaced by the codename of your release

(You can find your current codename using lsb_release -cs)

Check which releases we have a build for here and change the Suites: line to specify our latest LTS release instead of your codename.

(Even if our latest build is an LTS release behind there should be no issues, since cheerp uses minimal dependencies)

$ sudo apt-get update
$ sudo apt-get install cheerp-core

Arch

Use our AUR package:

$ yay -S cheerp-git

This might take a while

cheerp-git will compile Cheerp from source. For a faster install, you can use the community-maintained cheerp-bin package which unpacks the Ubuntu package.

Build from source

Users on other Linux distributions must build Cheerp from source.

Installing Cheerp on Windows

Download the latest graphical installer from GitHub and follow the installation wizard. The default installation path is currently the only supported one.

You can also build Cheerp from source if you prefer.

If you are using WSL, follow the instructions for Linux.

Installing Cheerp on macOS

Download the DMG image for macOS from GitHub and install it by opening the image and drag-and-dropping Cheerp into the /Applications directory.

The binary is not signed so you may need to run the following to stop Gatekeeper from blocking the executable:

$ sudo xattr -d com.apple.quarantine /Applications/cheerp/bin/*

Testing

To check whether you have installed Cheerp correctly, you can run the following command:

$ /opt/cheerp/bin/clang++ --version

You should see the version of Cheerp that you have installed. If you see something like “no such file or directory”, then Cheerp is not installed correctly.

If you are having any problems, ask for help in the #support channel on our Discord server.

wasm

genericjs