.. _rez-env:

=======
rez-env
=======

.. program:: rez-env

Usage
=====

.. code-block:: text

   rez env [-h] [--shell {bash,csh,pwsh,sh,tcsh,zsh}] [--rcfile RCFILE]
                  [--norc] [-c COMMAND] [-s] [--ni] [--nl] [-b] [--paths PATHS]
                  [-t TIME] [--max-fails N] [--time-limit SECS] [-o FILE]
                  [-i FILE] [--exclude RULE [RULE ...]]
                  [--include RULE [RULE ...]] [--no-filters] [-p] [--strict]
                  [--patch-rank N] [--no-cache] [-q] [--fail-graph]
                  [--new-session] [--detached] [--no-passive] [--stats]
                  [--no-pkg-cache] [--pkg-cache-mode {sync,async}] [-v]
                  [PKG ...]
   

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

Open a rez-configured shell, possibly interactive.


Options
=======

.. option:: --shell 

   target shell type 

   **Choices**: ``bash``, ``csh``, ``pwsh``, ``sh``, ``tcsh``, ``zsh``

   **Default**: ``bash``

.. option:: --rcfile 

   source this file instead of the target shell's standard startup scripts, if possible

.. option:: --norc 

   skip loading of startup scripts

.. option:: -c, --command 

   execute command within rez environment and exit, instead of starting an interactive shell. Alternatively, list command after a ``--``. The command and arguments passed to :option:`-c` must be passed in as a single shell argument, whereas the command and arguments after ``--`` may be passed in as several shell arguments.

.. option:: -s, --stdin 

   read commands from standard input

.. option:: --ni, --no-implicit 

   don't add implicit packages to the request

.. option:: --nl, --no-local 

   don't load local packages

.. option:: -b, --build 

   create a build environment

.. option:: --paths 

   set package search path (use ``:`` separator)

.. option:: -t, --time 

   ignore packages released after the given time. Supported formats are: epoch time (eg 1393014494), or relative time (eg -10s, -5m, -0.5h, -10d)

.. option:: --max-fails <n>

   abort if the number of failed configuration attempts exceeds N

   **Default**: -1

.. option:: --time-limit <secs>

   abort if the resolve time exceeds SECS

   **Default**: -1

.. option:: -o, --output <file>

   store the context into an rxt file, instead of starting an interactive shell. Note that this will also store a failed resolve. If you use the special value ``-``, the context is written to stdout.

.. option:: -i, --input <file>

   use a previously saved context. Resolve settings, such as PKG, :option:`--ni` etc are ignored in this case

.. option:: --exclude <rule>

   add package exclusion filters, eg ``*.beta``. Note that these are added to the globally configured exclusions

.. option:: --include <rule>

   add package inclusion filters, eg ``mypkg``, ``boost-*``. Note that these are added to the globally configured inclusions

.. option:: --no-filters 

   turn off package filters. Note that any filters specified with :option:`--exclude`/:option:`--include` are still applied

.. option:: -p, --patch 

   patch the current context to create a new context

.. option:: --strict 

   strict patching. Ignored if :option:`--patch` is not present

.. option:: --patch-rank <n>

   patch rank. Ignored if :option:`--patch` is not present

.. option:: --no-cache 

   do not fetch cached resolves

.. option:: -q, --quiet 

   run in quiet mode (hides welcome message)

.. option:: --fail-graph 

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

.. option:: --new-session 

   start the shell in a new process group

.. option:: --detached 

   open a separate terminal

.. option:: --no-passive 

   only print actions that affect the solve (has an effect only when verbosity is enabled)

.. option:: --stats 

   print advanced solver stats

.. option:: --no-pkg-cache 

   Disable package caching

.. option:: --pkg-cache-mode 

   If provided, override the rezconfig's package_cache_async key. If ``sync``, the process will block until packages are cached. If ``async``, the process will not block while packages are cached.

   **Choices**: ``sync``, ``async``

.. option:: -v, --verbose 

   verbose mode, repeat for more verbosity