This page provides information on managing render jobs through a command line interface in Chaos Cloud.
Overview
With Chaos Cloud you are able to submit, queue, monitor, and organize your render jobs across projects. To manage render jobs in Chaos Cloud you can use its web-based interface or a command line interface. This page explains how to manage render jobs via а command line interface. All of the functions can be carried out manually with any command line tool, without opening a browser. To do so, you first have to navigate to the location of chaoscloud or chaoscloud.exe on your machine.
Default locations:
- Windows – %appdata%\Chaos Group\Cloud\Client\ccloud.exe
- macOS – /Applications/ChaosGroup/Cloud\Client/cscloud
- Linux – $HOME/.ChaosGroup/vcloud/client/ccloud.bin
Managing Jobs Through a Command Line Interface in Chaos Group
The table below lists all available flags and commands. All commands can be run with multiple tags.
| Command | Flag(s) | Flag meaning | Function | Examples |
|---|---|---|---|---|
auth login | – | – | Logs in to Chaos Cloud. | ccloud auth login |
| auth logout | – | – | Logs out of Chaos Cloud. | ccloud auth logout |
eula | – | – | Prints out the EULA. | ccloud eula |
| job cancel | --id (required) | Render Job ID | Cancels a Chaos Cloud job. | ccloud job cancel --id=X8hC6Xg2cb8JeL5 |
| job delete | --id (required) | Render Job ID | Deletes a Chaos Cloud job. | ccloud job delete --id=X8hC6Xg2cb8JeL5 |
| job download | --id (required) --no-progress --output (required) | Render Job ID Do not display progress when downloading Path to output folder | Downloads outputs of a Chaos Cloud job. | ccloud job download --id=X8hC6Xg2cb8JeL5 --output="C:\Users\Me\Desktop" |
| job pause | --id (required) | Render Job ID | Pauses a Chaos Cloud job. | ccloud job pause --id=X8hC6Xg2cb8JeL5 |
| job rename | --id (required) --title (required) | Render Job ID The new title of the V-Ray Cloud job | Renames a Chaos Cloud job. | ccloud job rename --id=X8hC6Xg2cb8JeL5 --title="Marbles" |
| job submit | --sceneFile (required) --animation --colorCorrectionsFile --frameRange --frameStep --height --width --ignoreWarnings --name --no-progress --preserveAlpha --project --renderMode --vr | Path to .vrscene file Renders animation instead of a single shot Path to color corrections file Frame range of the animation Frame step of the animation Height of the rendered image Width of the rendered image Ignore warnings in scene file processing Name of the rendering job Do not display progress while submitting Preserve alpha channel of PNG output Name of the rendering project Specifies the render mode Renders VR-enabled image | Submits a V-Ray scene to Chaos Cloud. | ccloud job submit --sceneFile="C:\Users\Me\Desktop\soccer.vrscene --exr --project="Project Cloud" --renderMode=progressive --width=1280 --height=720 |
| job resubmit | --id (required) --animation --colorCorrectionsFile --frameRange --frameStep --height --width --ignoreWarnings --name --no-progress --preserveAlpha --project --renderMode --vr | Render Job ID Renders animation instead of a single shot Path to color corrections file Frame range of the animation Frame step of the animation Height of the rendered image Width of the rendered image Ignore warnings in scene file processing Name of the rendering job Do not display progress while submitting Preserve alpha channel of PNG output Name of the rendering project Specifies the render mode Renders VR-enabled image | Resubmits a V-Ray scene to Chaos Cloud. | ccloud job resubmit --sceneFile="C:\Users\Me\Desktop\soccer.vrscene --png --project="Chaosology" --renderMode=bucket --animation --frameRange=30 --ignoreWarnings |
| job start | --id (required) | Render Job ID | Starts a V-Ray Cloud job. | ccloud job start --id=X40YITIaqtb_94E |
| job status | --id (required) | Render Job ID | Prints status info for a Chaos Cloud job. | |
| project create | --name (required) --default | Name of the project Marks the project as default | Creates a new project. | ccloud project create --name="Cloudy" --default |
| project delete | --name (required) | Name of the project | Deletes a project. | ccloud project delete --name="Drains" |
| project list | – | – | Lists available projects. | ccloud project list |
| project rename | --name (required) --to (required) | Name of the project The new name of the project | Renames a Chaos Cloud project. | ccloud project rename --name="Marbles" --to="Drains" |
| update | – | – | Updates the Chaos Cloud Client. | ccloud update |
| version | – | – | Prints Chaos Cloud Client version info. | ccloud version |
| help | – | – | Prints command information. | ccloud help; ccloud job help; ccloud job submit help |
How to Get a Job ID
The ID of a render job can be obtained in two ways:
- from the Chaos Cloud's URL of the web interface when the Job Details page is open
- upon submission, through а command line interface, as shown in the image below
For more information, see Submitting Render Jobs Through the Chaos Cloud application (command line).
