.. _emscripten-toolchain-top:

=================================
Emscripten Toolchain Requirements
=================================

The instructions below list the main tools and dependencies in an Emscripten environment, along with instructions on how to test which dependencies are installed.

.. tip:: The :ref:`SDK <sdk-download-and-install>` provides the **easiest** and **most reliable** method for getting, using, updating and managing Emscripten environments. If you're using the SDK you won't *need* these instructions — they are provided for information only.

  The instructions below are useful if you're :ref:`manually <installing-from-source>` building from source.

.. _toolchain-what-you-need:

What you'll need
================

.. _central-list-of-emscripten-tools-and-dependencies:

Emscripten tools and dependencies
---------------------------------

In general a complete Emscripten environment requires the following tools. First test to see if they are already installed using the :ref:`instructions below <toolchain-test-which-dependencies-are-installed>`.

  - :term:`Node.js` (0.8 or above; 0.10.17 or above to run websocket-using servers in node)
  - :term:`Python` (3.6 or above)
    site/source/docs/building_from_source/toolchain_what_is_needed.rst
  - :term:`Java` (1.6.0_31 or later). Java is optional. It can be used to run the java version of term:`Closure Compiler`.
  - :term:`Git` client. Git is required if building tools from source.
  - :term:`LLVM` (LLVM, including clang and wasm-ld)
  - :term:`Binaryen` (Binaryen, including wasm-opt, wasm-emscripten-finalize, etc.)
  - The `Emscripten code <https://github.com/emscripten-core/emscripten>`_, from GitHub

.. note: 64-bit versions of all needed dependencies are preferred, and may be required if you are building large projects.

.. note:: The `Spidermonkey shell <https://developer.mozilla.org/en-US/docs/Mozilla/Projects/SpiderMonkey/Introduction_to_the_JavaScript_shell>`_ is also required if you want to run **100%** of the tests in the test suite. Most developers will not need this, and should instead use *node.js*.

.. _compiler-toolchain:

Compiler toolchain
------------------

When building Emscripten from source code, whether "manually" or using the SDK, you will need a *compiler toolchain*:

- Windows: Install `Visual Studio 2017 <http://go.microsoft.com/?linkid=9709949>`_ and `cmake <http://www.cmake.org/cmake/resources/software.html>`_.

  .. note::

    - SDK users can also install and activate the MinGW compiler toolchain in order to build their own projects:

      ::

        emsdk install mingw-4.6.2-32bit
        emsdk activate mingw-4.6.2-32bit


- Linux: Install *gcc* and *cmake*:

  ::

    #Install gcc
    sudo apt-get install build-essential
    # Install cmake
    sudo apt-get install cmake

- macOS: Install the *Xcode Command Line Tools*:

  -  Install Xcode from the `macOS App Store <http://superuser.com/questions/455214/where-is-svn-on-os-x-mountain-lion>`_.
  -  In **Xcode | Preferences | Downloads**, install *Command Line Tools*.

.. note:: Building LLVM and Clang from source can require a lot of memory and hard drive space. The specific requirements change from LLVM version to another, but you probably need at least 2GB of RAM, preferably 4GB or more. Debug builds or builds with assertions can require even more memory.

.. _toolchain-test-which-dependencies-are-installed:

Test which tools are installed
==============================

Some of the tools are pre-installed on the various platforms (for example, Python is always available on Linux builds).

You can check which tools are already present using the following commands:

::

  # Check for Python
  python --version

  # Check for node.js on Linux
  nodejs --version

  # Check for node.js on Windows
  node --version

  # Check for node.js on macOS
  node -v

  # Check for git
  git --version

  # Check for Java
  java -version

  # Check for gcc / g++
  gcc --version
  g++

  # Check for cmake
  cmake

