.. _rez-suite:

=========
rez-suite
=========

.. program:: rez-suite

Usage
=====

.. code-block:: text

   rez suite [-h] [-l] [-t] [--which TOOL] [--validate] [--create]
                    [-c NAME] [-i] [-a RXT] [-P CHAR] [-r NAME] [-d DESC]
                    [-p PREFIX] [-s SUFFIX] [--hide TOOL] [--unhide TOOL]
                    [--alias TOOL ALIAS] [--unalias TOOL] [-b NAME]
                    [--find-request PKG] [--find-resolve PKG] [-v]
                    [DIR]
   

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

Manage a suite or print information about an existing suite.


Options
=======

.. option:: -l, --list 

   list visible suites

.. option:: -t, --tools 

   print a list of the executables available in the suite

.. option:: --which <tool>

   print path to the tool in the suite, if it exists

.. option:: --validate 

   validate the suite

.. option:: --create 

   create an empty suite at DIR

.. option:: -c, --context <name>

   specify a context name (only used when using a context-specific option, such as :option:`--add`)

.. option:: -i, --interactive 

   enter an interactive shell in the given context

.. option:: -a, --add <rxt>

   add a context to the suite

.. option:: -P, --prefix-char <char>

   set the char used to access rez options via a suite tool for the context being added (default: ``+``). If set to the empty string, rez options are disabled. This option is only used in combination with :option:`--add`

.. option:: -r, --remove <name>

   remove a context from the suite

.. option:: -d, --description <desc>

   set the description of a context in the suite

.. option:: -p, --prefix 

   set the prefix of a context in the suite

.. option:: -s, --suffix 

   set the suffix of a context in the suite

.. option:: --hide <tool>

   hide a tool of a context in the suite

.. option:: --unhide <tool>

   unhide a tool of a context in the suite

.. option:: --alias <('tool', 'alias')>

   create an alias for a tool in the suite

.. option:: --unalias <tool>

   remove an alias for a tool in the suite

.. option:: -b, --bump <name>

   bump a context, making its tools higher priority than others

.. option:: --find-request <pkg>

   find the contexts that contain the given package in the request

.. option:: --find-resolve <pkg>

   find the contexts that contain the given package in the resolve

.. option:: -v, --verbose 

   verbose mode, repeat for more verbosity