Skip to content

Command Line Tools

github.com/davidlatwe edited this page May 6, 2021 · 1 revision

Auto-generated from wiki/update-wiki.py:make_cli_markdown()

rez

rez [-h] [-i] [-V] [-v] COMMAND ...
COMMAND Description
bind Create a Rez package for existing software.
build Build a package from source.
config Print current rez settings.
context Print information about the current rez context, or a given context file.
cp Copy a package from one repository to another.
depends Perform a reverse package dependency lookup.
diff Compare the source code of two packages.
env Open a rez-configured shell, possibly interactive.
gui Run the Rez GUI application.
help Utility for displaying help for the given package.
interpret Execute some Rex code and print the interpreted result.
memcache Manage and query memcache server(s).
pip Install a pip-compatible python package, and its dependencies, as rez packages.
pkg-cache Manipulate a package cache.
plugins Get a list of a package's plugins.
python Start a python interpreter or execute a python script within Rez's own execution context.
release Build a package from source and deploy it.
search Search for packages
selftest Run unit tests.
status Report current status of the environment, or a tool or package etc.
suite Manage a suite or print information about an existing suite.
test Run tests listed in a package's definition file.
view View the contents of a package.
yaml2py Print a package.yaml file in package.py format.

Flags

  -h, --help     show this help message and exit
  -i, --info     print information about rez and exit (default: False)
  -V, --version  show program's version number and exit
  -v, --verbose  verbose mode, repeat for more verbosity (default: 0)

rez bind

rez bind [-h] [--quickstart] [-r] [-i PATH] [--no-deps]
         [-l] [-s] [-v]
         [PKG] ...

Create a Rez package for existing software.

Arguments

  PKG               package to bind (default: None)
  ARG               extra arguments to the target bind module. Use '-h' to
                    show help for the module

Flags

  -h, --help        show this help message and exit
  --quickstart      bind a set of standard packages to get started
                    (default: False)
  -r, --release     install to release path; overrides -i (default: False)
  -i PATH, --install-path PATH
                    install path, defaults to local package path (default:
                    None)
  --no-deps         Do not bind dependencies (default: False)
  -l, --list        list all available bind modules (default: False)
  -s, --search      search for the bind module but do not perform the bind
                    (default: False)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez build

rez build [-h] [-c] [-i] [-p PATH] [--fail-graph] [-s]
          [--view-pre] [--process {local,remote}]
          [-b BUILDSYS] [--variants INDEX [INDEX ...]]
          [--ba ARGS] [--cba ARGS] [-v]

Build a package from source.

Arguments

Flags

  -h, --help        show this help message and exit
  -c, --clean       clear the current build before rebuilding. (default:
                    False)
  -i, --install     install the build to the local packages path. Use
                    --prefix to choose a custom install path. (default:
                    False)
  -p PATH, --prefix PATH
                    install to a custom package repository path. (default:
                    None)
  --fail-graph      if the build environment fails to resolve due to a
                    conflict, display the resolve graph as an image.
                    (default: False)
  -s, --scripts     create build scripts rather than performing the full
                    build. Running these scripts will place you into a
                    build environment, where you can invoke the build
                    system directly. (default: False)
  --view-pre        just view the preprocessed package definition, and
                    exit. (default: False)
  --process {local,remote}
                    the build process to use (default: local).
  -b BUILDSYS, --build-system BUILDSYS
                    the build system to use. If not specified, it is
                    detected. Set 'build_system' or 'build_command' to
                    specify the build system in the package itself.
                    (default: None)
  --variants INDEX [INDEX ...]
                    select variants to build (zero-indexed). (default:
                    None)
  --ba ARGS, --build-args ARGS
                    arguments to pass to the build system. Alternatively,
                    list these after a '--'. (default: None)
  --cba ARGS, --child-build-args ARGS
                    arguments to pass to the child build system, if any.
                    Alternatively, list these after a second '--'.
                    (default: None)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez config

rez config [-h] [--search-list] [--source-list] [-v]
           [FIELD]

Print current rez settings.

Arguments

  FIELD          print the value of a specific setting (default: None)

Flags

  -h, --help     show this help message and exit
  --search-list  list the config files searched (default: False)
  --source-list  list the config files sourced (default: False)
  -v, --verbose  verbose mode, repeat for more verbosity (default: 0)

rez context

rez context [-h] [--req] [--res] [--so] [--su] [-t]
            [--which CMD] [-g] [--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]

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

Arguments

  RXT               rez context file (current context if not supplied).
                    Use '-' to read the context from stdin (default: None)

Flags

  -h, --help        show this help message and exit
  --req, --print-request
                    print only the request list (not including implicits)
                    (default: False)
  --res, --print-resolve
                    print only the resolve list. Use with --su to print
                    package URIs (default: False)
  --so, --source-order
                    print resolved packages in order they are sorted,
                    rather than alphabetical order (default: False)
  --su, --show-uris
                    list resolved package's URIs, rather than the default
                    'root' filepath (default: False)
  -t, --tools       print a list of the executables available in the
                    context (default: False)
  --which CMD       locate a program within the context (default: None)
  -g, --graph       display the resolve graph as an image (default: False)
  --pg, --print-graph
                    print the resolve graph as a string (default: False)
  --wg FILE, --write-graph FILE
                    write the resolve graph to FILE (default: None)
  --pp PKG, --prune-package PKG
                    prune the graph down to PKG (default: None)
  -i, --interpret   interpret the context and print the resulting code
                    (default: False)
  -f {bash,csh,pwsh,sh,tcsh,zsh,dict,table,json}, --format {bash,csh,pwsh,sh,tcsh,zsh,dict,table,json}
                    print interpreted output in the given format. Ignored
                    if --interpret is not present (default: bash). If one
                    of table, dict or json, the environ dict is printed.
  -s {file,eval}, --style {file,eval}
                    Set code output style. Ignored if --interpret is not
                    present (default: file)
  --no-env          interpret the context in an empty environment
                    (default: False)
  --diff RXT        diff the current context against the given context
                    (default: None)
  --fetch           diff the current context against a re-resolved copy of
                    the current context (default: False)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez complete

rez complete [-h] [-v]

Arguments

Flags

  -h, --help     show this help message and exit
  -v, --verbose  verbose mode, repeat for more verbosity (default: 0)

rez cp

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]

Copy a package from one repository to another.

Arguments

  PKG               package to copy (default: None)

Flags

  -h, --help        show this help message and exit
  --dest-path PATH  package repository destination path. Defaults to the
                    same repository as the given package (this is only
                    supported for renaming and reversioning). (default:
                    None)
  --paths PATHS     set package search path (ignores --no-local if set)
                    (default: None)
  --nl, --no-local  don't search local packages (default: False)
  --reversion VERSION
                    copy to a different package version (default: None)
  --rename NAME     copy to a different package name (default: None)
  -o, --overwrite   overwrite existing package/variants (default: False)
  -s, --shallow     perform a shallow copy (symlinks topmost directories)
                    (default: False)
  --follow-symlinks
                    follow symlinks when copying package payload, rather
                    than copying the symlinks themselves. (default: False)
  -k, --keep-timestamp
                    keep timestamp of source package. Note that this is
                    ignored if you're copying variant(s) into an existing
                    package. (default: False)
  -f, --force       copy package even if it isn't relocatable (use at your
                    own risk) (default: False)
  --allow-empty     allow package copy into empty target repository
                    (default: False)
  --dry-run         dry run mode (default: False)
  --variants INDEX [INDEX ...]
                    select variants to copy (zero-indexed). (default:
                    None)
  --variant-uri URI
                    copy variant with the given URI. Ignores --variants.
                    (default: None)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez depends

rez depends [-h] [-d DEPTH] [--paths PATHS] [-b] [-p]
            [-g] [--pg] [--wg FILE] [-q] [-v]
            PKG

Perform a reverse package dependency lookup.

Arguments

  PKG               package that other packages depend on

Flags

  -h, --help        show this help message and exit
  -d DEPTH, --depth DEPTH
                    dependency tree depth limit (default: None)
  --paths PATHS     set package search path (default: None)
  -b, --build-requires
                    Include build requirements (default: False)
  -p, --private-build-requires
                    Include private build requirements of PKG, if any
                    (default: False)
  -g, --graph       display the dependency tree as an image (default:
                    False)
  --pg, --print-graph
                    print the dependency tree as a string (default: False)
  --wg FILE, --write-graph FILE
                    write the dependency tree to FILE (default: None)
  -q, --quiet       don't print progress bar or depth indicators (default:
                    False)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez diff

rez diff [-h] [-v] PKG1 [PKG2]

Compare the source code of two packages.

Arguments

  PKG1           package to diff
  PKG2           package to diff against. If not provided, the next
                 highest versioned package is used (default: None)

Flags

  -h, --help     show this help message and exit
  -v, --verbose  verbose mode, repeat for more verbosity (default: 0)

rez env

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] [-v]
        [PKG [PKG ...]]

Open a rez-configured shell, possibly interactive.

Arguments

  PKG               packages to use in the target environment (default:
                    None)

Flags

  -h, --help        show this help message and exit
  --shell {bash,csh,pwsh,sh,tcsh,zsh}
                    target shell type (default: bash)
  --rcfile RCFILE   source this file instead of the target shell's
                    standard startup scripts, if possible (default: None)
  --norc            skip loading of startup scripts (default: False)
  -c COMMAND, --command COMMAND
                    read commands from string. Alternatively, list command
                    arguments after a '--' (default: None)
  -s, --stdin       read commands from standard input (default: False)
  --ni, --no-implicit
                    don't add implicit packages to the request (default:
                    False)
  --nl, --no-local  don't load local packages (default: False)
  -b, --build       create a build environment (default: False)
  --paths PATHS     set package search path (default: None)
  -t TIME, --time TIME
                    ignore packages released after the given time.
                    Supported formats are: epoch time (eg 1393014494), or
                    relative time (eg -10s, -5m, -0.5h, -10d) (default:
                    None)
  --max-fails N     abort if the number of failed configuration attempts
                    exceeds N (default: -1)
  --time-limit SECS
                    abort if the resolve time exceeds SECS (default: -1)
  -o FILE, --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. (default:
                    None)
  -i FILE, --input FILE
                    use a previously saved context. Resolve settings, such
                    as PKG, --ni etc are ignored in this case (default:
                    None)
  --exclude RULE [RULE ...]
                    add package exclusion filters, eg '*.beta'. Note that
                    these are added to the globally configured exclusions
                    (default: None)
  --include RULE [RULE ...]
                    add package inclusion filters, eg 'mypkg', 'boost-*'.
                    Note that these are added to the globally configured
                    inclusions (default: None)
  --no-filters      turn off package filters. Note that any filters
                    specified with --exclude/--include are still applied
                    (default: False)
  -p, --patch       patch the current context to create a new context
                    (default: False)
  --strict          strict patching. Ignored if --patch is not present
                    (default: False)
  --patch-rank N    patch rank. Ignored if --patch is not present
                    (default: 0)
  --no-cache        do not fetch cached resolves (default: False)
  -q, --quiet       run in quiet mode (hides welcome message) (default:
                    False)
  --fail-graph      if the build environment fails to resolve due to a
                    conflict, display the resolve graph as an image.
                    (default: False)
  --new-session     start the shell in a new process group (default:
                    False)
  --detached        open a separate terminal (default: False)
  --no-passive      only print actions that affect the solve (has an
                    effect only when verbosity is enabled) (default:
                    False)
  --stats           print advanced solver stats (default: False)
  --no-pkg-cache    Disable package caching (default: False)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez forward

rez forward [-h] [-v] YAML ...

Arguments

  YAML
  ARG

Flags

  -h, --help     show this help message and exit
  -v, --verbose  verbose mode, repeat for more verbosity (default: 0)

rez gui

rez gui [-h] [--diff RXT1 RXT2] [-v] [FILE [FILE ...]]

Run the Rez GUI application.

Arguments

  FILE              context files (default: None)

Flags

  -h, --help        show this help message and exit
  --diff RXT1 RXT2  open in diff mode with the given contexts (default:
                    None)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez help

rez help [-h] [-m] [-e] [-v] [PACKAGE] [SECTION]

Utility for displaying help for the given package.

Arguments

  PACKAGE        package name (default: None)
  SECTION        Help section to view (1..N) (default: 1)

Flags

  -h, --help     show this help message and exit
  -m, --manual   Load the rez technical user manual (default: False)
  -e, --entries  Just print each help entry (default: False)
  -v, --verbose  verbose mode, repeat for more verbosity (default: 0)

rez interpret

rez interpret [-h]
              [-f {bash,csh,pwsh,sh,tcsh,zsh,dict,table}]
              [--no-env] [--pv VAR [VAR ...]] [-v]
              FILE

Execute some Rex code and print the interpreted result.

Arguments

  FILE              file containing rex code to execute

Flags

  -h, --help        show this help message and exit
  -f {bash,csh,pwsh,sh,tcsh,zsh,dict,table}, --format {bash,csh,pwsh,sh,tcsh,zsh,dict,table}
                    print output in the given format. If None, the current
                    shell language (bash) is used (default: None)
  --no-env          interpret the code in an empty environment (default:
                    False)
  --pv VAR [VAR ...], --parent-variables VAR [VAR ...]
                    environment variables to update rather than overwrite
                    on first reference. If this is set to the special
                    value 'all', all variables will be treated this way
                    (default: None)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez memcache

rez memcache [-h] [--flush] [--stats] [--reset-stats]
             [--poll] [--interval SECS] [--warm] [-v]

Manage and query memcache server(s).

Arguments

Flags

  -h, --help       show this help message and exit
  --flush          flush all cache entries (default: False)
  --stats          list stats (default: False)
  --reset-stats    reset statistics (default: False)
  --poll           continually poll, showing get/sets per second (default:
                   False)
  --interval SECS  interval (in seconds) used when polling (default: 1.0)
  --warm           warm the cache server with visible packages (default:
                   False)
  -v, --verbose    verbose mode, repeat for more verbosity (default: 0)

rez pip

rez pip [-h] [--python-version VERSION]
        [--pip-version VERSION] [-i] [-s] [-r] [-p PATH]
        [-e ...] [-v]
        PACKAGE

Install a pip-compatible python package, and its dependencies, as rez packages.

Arguments

  PACKAGE           package to install or archive/url to install from

Flags

  -h, --help        show this help message and exit
  --python-version VERSION
                    python version (rez package) to use, default is
                    latest. Note that the pip package(s) will be installed
                    with a dependency on python-MAJOR.MINOR. (default:
                    None)
  --pip-version VERSION
                    pip version (rez package) to use, default is latest.
                    This option is deprecated and will be removed in the
                    future. (default: None)
  -i, --install     install the package (default: False)
  -s, --search      search for the package on PyPi (default: False)
  -r, --release     install as released package; if not set, package is
                    installed locally only (default: False)
  -p PATH, --prefix PATH
                    install to a custom package repository path. (default:
                    None)
  -e ..., --extra ...
                    extra args passthrough to pip install (overrides pre-
                    configured args if specified) (default: None)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez pkg-cache

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

Manipulate a package cache.

Arguments

  DIR               Package cache directory; will use config setting
                    'cache_packages_path' if not provided (default: None)

Flags

  -h, --help        show this help message and exit
  -a URI [URI ...], --add-variants URI [URI ...]
                    Add variants to the cache (default: None)
  --logs            View logs (default: False)
  -r URI [URI ...], --remove-variants URI [URI ...]
                    Remove variants from cache (default: None)
  --clean           Remove unused variants and other cache files pending
                    deletion (default: False)
  -c {status,package,variant_uri,orig_path,cache_path} [{status,package,variant_uri,orig_path,cache_path} ...], --columns {status,package,variant_uri,orig_path,cache_path} [{status,package,variant_uri,orig_path,cache_path} ...]
                    Columns to print, choose from: status, package,
                    variant_uri, orig_path, cache_path (default:
                    ['status', 'package', 'variant_uri', 'cache_path'])
  -f, --force       Force a package add, even if package is not cachable.
                    Only applicable with --add (default: False)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez plugins

rez plugins [-h] [--paths PATHS] [-v] PKG

Get a list of a package's plugins.

Arguments

  PKG            package to list plugins for

Flags

  -h, --help     show this help message and exit
  --paths PATHS  set package search path (default: None)
  -v, --verbose  verbose mode, repeat for more verbosity (default: 0)

rez python

rez python [-h] [-v] [FILE]

Start a python interpreter or execute a python script within Rez's own execution context. Unrecognised args are passed directly to the underlying python interpreter.

Arguments

  FILE           python script to execute (default: None)

Flags

  -h, --help     show this help message and exit
  -v, --verbose  verbose mode, repeat for more verbosity (default: 0)

rez release

rez release [-h] [-m MESSAGE] [--vcs {git,hg,stub}]
            [--no-latest] [--ignore-existing-tag]
            [--skip-repo-errors] [--no-message]
            [--process {local,remote}] [-b BUILDSYS]
            [--variants INDEX [INDEX ...]] [--ba ARGS]
            [--cba ARGS] [-v]

Build a package from source and deploy it.

Arguments

Flags

  -h, --help        show this help message and exit
  -m MESSAGE, --message MESSAGE
                    release message (default: None)
  --vcs {git,hg,stub}
                    force the vcs type to use (default: None)
  --no-latest       allows release of version earlier than the latest
                    release. (default: False)
  --ignore-existing-tag
                    perform the release even if the repository is already
                    tagged at the current version. If the config setting
                    plugins.release_vcs.check_tag is false, this option
                    has no effect. (default: False)
  --skip-repo-errors
                    release even if repository-related errors occur. DO
                    NOT use this option unless you absolutely must release
                    a package, despite there being a problem (such as
                    inability to contact the repository server) (default:
                    False)
  --no-message      do not prompt for release message. (default: False)
  --process {local,remote}
                    the build process to use (default: local).
  -b BUILDSYS, --build-system BUILDSYS
                    the build system to use. If not specified, it is
                    detected. Set 'build_system' or 'build_command' to
                    specify the build system in the package itself.
                    (default: None)
  --variants INDEX [INDEX ...]
                    select variants to build (zero-indexed). (default:
                    None)
  --ba ARGS, --build-args ARGS
                    arguments to pass to the build system. Alternatively,
                    list these after a '--'. (default: None)
  --cba ARGS, --child-build-args ARGS
                    arguments to pass to the child build system, if any.
                    Alternatively, list these after a second '--'.
                    (default: None)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez search

rez search [-h] [-t {package,family,variant,auto}] [--nl]
           [--validate] [--paths PATHS] [-f FORMAT]
           [--no-newlines] [-l] [-e] [--nw]
           [--before BEFORE] [--after AFTER] [-s] [-v]
           [PKG]

Search for packages

Arguments

  PKG               packages to search, glob-style patterns are supported
                    (default: None)

Flags

  -h, --help        show this help message and exit
  -t {package,family,variant,auto}, --type {package,family,variant,auto}
                    type of resource to search for. If 'auto', either
                    packages or package families are searched, depending
                    on the value of PKG (default: auto)
  --nl, --no-local  don't search local packages (default: False)
  --validate        validate each resource that is found (default: False)
  --paths PATHS     set package search path (ignores --no-local if set)
                    (default: None)
  -f FORMAT, --format FORMAT
                    format package output, eg --format='{qualified_name} |
                    {description}'. Valid fields include: authors, base,
                    build_requires, changelog, commands, description,
                    index, name, num_variants, post_commands,
                    pre_commands, private_build_requires, qualified_name,
                    release_message, requires, revision, root, timestamp,
                    tools, uri, uuid, variants, version (default: None)
  --no-newlines     print newlines as '\n' rather than actual newlines
                    (default: False)
  -l, --latest      when searching packages, only show the latest version
                    of each package (default: False)
  -e, --errors      only print packages containing errors (implies
                    --validate) (default: False)
  --nw, --no-warnings
                    suppress warnings (default: False)
  --before BEFORE   only show packages released before the given time.
                    Supported formats are: epoch time (eg 1393014494), or
                    relative time (eg -10s, -5m, -0.5h, -10d) (default: 0)
  --after AFTER     only show packages released after the given time.
                    Supported formats are: epoch time (eg 1393014494), or
                    relative time (eg -10s, -5m, -0.5h, -10d) (default: 0)
  -s, --sort        print results in sorted order (deprecated) (default:
                    False)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez selftest

rez selftest [-h] [-s SHELL] [--build] [--commands]
             [--completion] [--config] [--context]
             [--copy_package] [--formatter] [--imports]
             [--package_cache] [--packages]
             [--packages_order] [--pip_utils]
             [--release] [--resources_] [--rex]
             [--schema] [--shells] [--solver]
             [--suites] [--utils] [--version] [-v]
             [NAMED_TEST [NAMED_TEST ...]]

Run unit tests.

Arguments

  NAMED_TEST        a specific test module/class/method to run; may be
                    repeated multiple times; if no tests are given,
                    through this or other flags, all tests are run
                    (default: [])

Flags

  -h, --help        show this help message and exit
  -s SHELL, --only-shell SHELL
                    limit shell-dependent tests to the specified shell
                    (default: None)
  --build           test the build system (default: [])
  --commands        test package commands (default: [])
  --completion      test completions (default: [])
  --config          test configuration settings (default: [])
  --context         test resolved contexts (default: [])
  --copy_package    test package copying (default: [])
  --formatter       test rex string formatting (default: [])
  --imports         test importing of all source (default: [])
  --package_cache   Test package caching (default: [])
  --packages        test package iteration, serialization etc (default:
                    [])
  --packages_order  Test cases for package_order.py (package ordering)
                    (default: [])
  --pip_utils       test the pip utilities (default: [])
  --release         test the release system (default: [])
  --resources_      test core resource system (default: [])
  --rex             test the rex command generator API (default: [])
  --schema          unit tests for 'schema' module (default: [])
  --shells          test shell invocation (default: [])
  --solver          test dependency resolving algorithm (default: [])
  --suites          test suites (default: [])
  --utils           unit tests for 'utils.filesystem' module (default: [])
  --version         unit tests for 'version' module (default: [])
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez status

rez status [-h] [-t] [-v] [OBJECT]

Report current status of the environment, or a tool or package etc.

Arguments

  OBJECT         object to query - this could be a tool, package, context
                 or suite. If not provided, a summary of the current
                 environment is shown. (default: None)

Flags

  -h, --help     show this help message and exit
  -t, --tools    List visible tools. In this mode, OBJECT can be a glob
                 pattern such as 'foo*' (default: False)
  -v, --verbose  verbose mode, repeat for more verbosity (default: 0)

rez suite

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]

Manage a suite or print information about an existing suite.

Arguments

  DIR               directory of suite to create or manage (default: None)

Flags

  -h, --help        show this help message and exit
  -l, --list        list visible suites (default: False)
  -t, --tools       print a list of the executables available in the suite
                    (default: False)
  --which TOOL      print path to the tool in the suite, if it exists
                    (default: None)
  --validate        validate the suite (default: False)
  --create          create an empty suite at DIR (default: False)
  -c NAME, --context NAME
                    specify a context name (only used when using a
                    context-specific option, such as --add) (default:
                    None)
  -i, --interactive
                    enter an interactive shell in the given context
                    (default: False)
  -a RXT, --add RXT
                    add a context to the suite (default: None)
  -P CHAR, --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 --add
                    (default: None)
  -r NAME, --remove NAME
                    remove a context from the suite (default: None)
  -d DESC, --description DESC
                    set the description of a context in the suite
                    (default: None)
  -p PREFIX, --prefix PREFIX
                    set the prefix of a context in the suite (default:
                    None)
  -s SUFFIX, --suffix SUFFIX
                    set the suffix of a context in the suite (default:
                    None)
  --hide TOOL       hide a tool of a context in the suite (default: None)
  --unhide TOOL     unhide a tool of a context in the suite (default:
                    None)
  --alias TOOL ALIAS
                    create an alias for a tool in the suite (default:
                    None)
  --unalias TOOL    remove an alias for a tool in the suite (default:
                    None)
  -b NAME, --bump NAME
                    bump a context, making its tools higher priority than
                    others (default: None)
  --find-request PKG
                    find the contexts that contain the given package in
                    the request (default: None)
  --find-resolve PKG
                    find the contexts that contain the given package in
                    the resolve (default: None)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez test

rez test [-h] [-l] [--dry-run] [-s] [--inplace]
         [--extra-packages PKG [PKG ...]] [--paths PATHS]
         [--nl] [-v]
         PKG [TEST [TEST ...]]

Run tests listed in a package's definition file.

Arguments

  PKG               package run tests on
  TEST              tests to run (run all if not provided) (default: None)

Flags

  -h, --help        show this help message and exit
  -l, --list        list package's tests and exit (default: False)
  --dry-run         dry-run mode: show what tests would have been run, but
                    do not run them (default: False)
  -s, --stop-on-fail
                    stop on first test failure (default: False)
  --inplace         run tests in the current environment. Any test whose
                    requirements are not met by the current environment is
                    skipped (default: False)
  --extra-packages PKG [PKG ...]
                    extra packages to add to test environment (default:
                    None)
  --paths PATHS     set package search path (default: None)
  --nl, --no-local  don't load local packages (default: False)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez view

rez view [-h] [-f {py,yaml}] [-a] [-b] [-c] [-v] PKG

View the contents of a package.

Arguments

  PKG               the package to view

Flags

  -h, --help        show this help message and exit
  -f {py,yaml}, --format {py,yaml}
                    format to print the package in (default: yaml)
  -a, --all         show all package data, including release-related
                    fields (default: False)
  -b, --brief       do not print extraneous info, such as package uri
                    (default: False)
  -c, --current     show the package in the current context, if any
                    (default: False)
  -v, --verbose     verbose mode, repeat for more verbosity (default: 0)

rez yaml2py

rez yaml2py [-h] [-v] [PATH]

Print a package.yaml file in package.py format.

Arguments

  PATH           path to yaml to convert, or directory to search for
                 package.yaml; cwd if not provided (default: None)

Flags

  -h, --help     show this help message and exit
  -v, --verbose  verbose mode, repeat for more verbosity (default: 0)
Clone this wiki locally