.. _rez-pkg-cache:

=============
rez-pkg-cache
=============

.. program:: rez-pkg-cache

Usage
=====

.. code-block:: text

   rez pkg-cache [-h] [-a URI [URI ...] | --logs | -r URI [URI ...] |
                        --clean] [--pkg-cache-mode {sync,async}]
                        [-c {status,package,variant_uri,orig_path,cache_path} [{status,package,variant_uri,orig_path,cache_path} ...]]
                        [-f] [-v]
                        [DIR]
   

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

Manipulate a package cache.


Options
=======

.. option:: -a, --add-variants <uri>

   Add variants to the cache

.. option:: --logs 

   View logs

.. option:: -r, --remove-variants <uri>

   Remove variants from cache

.. option:: --clean 

   Remove unused variants and other cache files pending deletion

.. 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:: -c, --columns 

   Columns to print, choose from: status, package, variant_uri, orig_path, cache_path

   **Choices**: ``status``, ``package``, ``variant_uri``, ``orig_path``, ``cache_path``

   **Default**: ['status', 'package', 'variant_uri', 'cache_path']

.. option:: -f, --force 

   Force a package add, even if package is not cachable. Only applicable with :option:`--add-variants`

.. option:: -v, --verbose 

   verbose mode, repeat for more verbosity