.. _rez-cp:

======
rez-cp
======

.. program:: rez-cp

Usage
=====

.. code-block:: text

   rez cp [-h] [--dest-path PATH] [--paths PATHS] [--nl]
                 [--reversion VERSION] [--rename NAME] [-o] [-s]
                 [--follow-symlinks] [-k] [-f] [--allow-empty] [--dry-run]
                 [--variants INDEX [INDEX ...]] [--variant-uri URI] [-v]
                 [PKG]
   

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

Copy a package from one repository to another.


Options
=======

.. option:: --dest-path <path>

   package repository destination path. Defaults to the same repository as the given package (this is only supported for renaming and reversioning).

.. option:: --paths <paths>

   set package search path (ignores :option:`--no-local` if set)

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

   don't search local packages

.. option:: --reversion <version>

   copy to a different package version

.. option:: --rename <name>

   copy to a different package name

.. option:: -o, --overwrite 

   overwrite existing package/variants

.. option:: -s, --shallow 

   perform a shallow copy (symlinks topmost directories)

.. option:: --follow-symlinks 

   follow symlinks when copying package payload, rather than copying the symlinks themselves.

.. option:: -k, --keep-timestamp 

   keep timestamp of source package. Note that this is ignored if you're copying variant(s) into an existing package.

.. option:: -f, --force 

   copy package even if it isn't relocatable (use at your own risk)

.. option:: --allow-empty 

   allow package copy into empty target repository

.. option:: --dry-run 

   dry run mode

.. option:: --variants <index>

   select variants to copy (zero-indexed).

.. option:: --variant-uri <uri>

   copy variant with the given URI. Ignores :option:`--variants`.

.. option:: -v, --verbose 

   verbose mode, repeat for more verbosity