1 Command Line Interface

SquidNet provides a user-side command line interface for remote job submission. The CCL utility is installed with the CUI installation and is located in the root installed folder. Support for Windows, MacOS and Linux is provided.

To open the CCL command terminal window, log into the CUI and select the “CCL Terminal” option from the “Admin” menu.

_images/open_ccl_command_line.png

CUI Desktop Interface

In the console terminal, get available options with the “ccl –help” command

_images/ccl_command_line.png

CCL Command Line Terminal

Common commands include:

  • ccl –help

  • ccl –config

  • ccl –templateList

  • ccl –poolShow

  • ccl –renderQueueShow

  • ccl –appProfileShow

To look for a specific option, use the “ccl–find <value>” option to filter command types. For example:

> ccl--find show

Cloud Rendering Command Line Interface.

Usage: ccl <options> ...

        Option                                        Description
        ----------------------------------------------------------------------------------------------------------------------------------------
        --appProfileShow                              Show application profiles.
        --columnShow                                  Show columns for specified command.
        --configShow                                  Show configuration.
        --cpuRendererShow                             List CPU Renderer options.
        --deliveryMethodShow                          Display download methods.
        --errorShow                                   Show status codes and descriptions (same as --statusShow).
        --ftpShow <path>                              Show ftp contents.
        --gpuRendererShow                             List GPU Renderer options.
        --gpuShow                                     GPU support list.
        --jobQueueShow                                Show job queue contents.
        --leaseShow                                   Show active leases.
        --lightWaveSceneShow <Lightwave scene path>   Dump lightwave scene file.
        --md5Show <path>                              Perform md5 hash on file or directory.
        --optionsShow                                 Show status of command line options.
        --packShow <path>                             Displayed pack file info.
        --poolShow                                    Show render pools.
        --renderCreditsShow                           Show available render credits.
        --renderPluginsShow <template-name>           Show applications supported by template.
        --renderQueueShow                             Show render queues.
        --rfidShow                                    Render Farm Id Show.
        --statusShow                                  Show status codes and descriptions (same as --errorShow).
        --tagShow                                     Show tag list.
        --templateShow <template-name>                Show templates command line options.
        --threadsShow                                 List active threads.
        --transferProtocolShow                        Show transfer protocols.

Application Command Line:

Last Updated on 2021-12-15