.. _csl-compiler:

CSL Compiler
============

The CSL compiler can be invoked with the command ``cslc`` on your terminal. See the following documentation describing the available options. See :ref:`working-with-code-samples` for usage examples.

.. code-block:: bash

    cslc --help
    OVERVIEW: CSL compiler

    USAGE: cslc [options] <input file>

    OPTIONS:

    CSL Compiler Options:

    --arch=<value>              - Choose the architecture of Cerebras system. Default=ein.
                                Allowed values are "=ein" for Einstein and
                                "=fyn" for Feynman.
    --colors=<value>            - Comma-separated list of color-to-value
                                mappings.The mapping is a "color:value" pair where color
                                is a string and value is an unsigned integer.
    --enable-statistics         - Print compiler related statistics.
    --fabric-dims=<uint>        - List of two comma-separated unsigned integers
                                representing the fabric width and the fabric
                                height.
    --fabric-offsets=<uint>     - List of two comma-separated unsigned integers
                                representing the horizontal and
                                vertical coordinates of the rectangle.
    -o=<prefix>                 - Specify the prefix of the output binary
                                file(s).
    --out-routes                - Show per-PE color and routing information.
    --params=<value>            - Comma-separated list of param-to-value
                                mappings. The mapping is a "name:value" pair
                                where name is a string and value is an unsigned
                                integer.
    -v                          - Verbose output

    Generic Options:

    --help                  - Display available options ("--help-hidden" for more).
    --help-list             - Display list of available options ("--help-list-hidden" for more).
    --version               - Display the version of this program.