.. _rez-build:

=========
rez-build
=========

.. program:: rez-build

Usage
=====

.. code-block:: text

   rez build [-h] [-c] [-i] [-p PATH] [--fail-graph] [-s] [--view-pre]
                    [--process {local,remote}] [-b BUILDSYS]
                    [--variants INDEX [INDEX ...]] [--ba ARGS] [--cba ARGS] [-v]
   

description
===========

Build a package from source.


Options
=======

.. option:: -c, --clean 

   clear the current build before rebuilding.

.. option:: -i, --install 

   install the build to the local packages path. Use :option:`--prefix` to choose a custom install path.

.. option:: -p, --prefix <path>

   install to a custom package repository path.

.. option:: --fail-graph 

   if the build environment fails to resolve due to a conflict, display the resolve graph as an image.

.. option:: -s, --scripts 

   create build scripts rather than performing the full build. Running these scripts will place you into a build environment, where you can invoke the build system directly.

.. option:: --view-pre 

   just view the preprocessed package definition, and exit.

.. option:: --process 

   the build process to use .

   **Choices**: ``local``, ``remote``

   **Default**: ``local``

.. option:: -b, --build-system 

   the build system to use. If not specified, it is detected. Set ``build_system`` or ``build_command`` to specify the build system in the package itself.

.. option:: --variants <index>

   select variants to build (zero-indexed).

.. option:: --ba, --build-args <args>

   arguments to pass to the build system. Alternatively, list these after a ``--``.

.. option:: --cba, --child-build-args <args>

   arguments to pass to the child build system, if any. Alternatively, list these after a second ``--``.

.. option:: -v, --verbose 

   verbose mode, repeat for more verbosity