.. _rez-context:

===========
rez-context
===========

.. program:: rez-context

Usage
=====

.. code-block:: text

   rez context [-h] [--req] [--res] [--so] [--su] [-t] [--which CMD] [-g]
                      [-d] [--pg] [--wg FILE] [--pp PKG] [-i]
                      [-f {bash,csh,pwsh,sh,tcsh,zsh,dict,table,json}]
                      [-s {file,eval}] [--no-env] [--diff RXT] [--fetch] [-v]
                      [RXT]
   

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

Print information about the current rez context, or a given context file.


Options
=======

.. option:: --req, --print-request 

   print only the request list (not including implicits)

.. option:: --res, --print-resolve 

   print only the resolve list. Use with :option:`--su` to print package URIs

.. option:: --so, --source-order 

   print resolved packages in order they are sorted, rather than alphabetical order

.. option:: --su, --show-uris 

   list resolved package's URIs, rather than the default ``root`` filepath

.. option:: -t, --tools 

   print a list of the executables available in the context

.. option:: --which <cmd>

   locate a program within the context

.. option:: -g, --graph 

   display the resolve graph as an image

.. option:: -d, --dependency-graph 

   display the (simpler) dependency graph. Works in combination with other graph options

.. option:: --pg, --print-graph 

   print the resolve graph as a string

.. option:: --wg, --write-graph <file>

   write the resolve graph to FILE

.. option:: --pp, --prune-package <pkg>

   prune the graph down to PKG

.. option:: -i, --interpret 

   interpret the context and print the resulting code

.. option:: -f, --format 

   print interpreted output in the given format. Ignored if :option:`--interpret` is not present . If one of table, dict or json, the environ dict is printed.

   **Choices**: ``bash``, ``csh``, ``pwsh``, ``sh``, ``tcsh``, ``zsh``, ``dict``, ``table``, ``json``

   **Default**: ``bash``

.. option:: -s, --style 

   Set code output style. Ignored if :option:`--interpret` is not present 

   **Choices**: ``file``, ``eval``

   **Default**: ``file``

.. option:: --no-env 

   interpret the context in an empty environment

.. option:: --diff <rxt>

   diff the current context against the given context

.. option:: --fetch 

   diff the current context against a re-resolved copy of the current context

.. option:: -v, --verbose 

   verbose mode, repeat for more verbosity