Cavalry CLI
Command Line Interface
General
Cavalry CLI (Command Line Interface) enables various tasks including rendering without the need to launch Cavalry itself.
To run (assuming you have installed Cavalry to the default locations):
macOS
Open Terminal (Applications/Utilities/Terminal).
Enter the following (hit enter after the first line).
Windows
Open Command Prompt.
Enter the following (hit enter after the first line)
Typing ./cavalry-cli -h
(macOS) or .\cavalry-cli -h
(Windows) followed by enter will output the following help information:
Render
Rendering via CLI is only available on the Professional plan.
Typing ./cavalry-cli render -h
(macOS) or .\cavalry-cli render -h
(Windows) followed by enter will output the following help information:
You can then use these flags to create your command.
For example, the below will render frames 0-50 of the file sceneName.cv as an animated png with the name outputFileName to your Desktop.
macOS
Windows
Render Tokens
To use Render Tokens to generate a File Name (-n
) with in a command wrap them in single or double quotes. For example the following examples will both work:
Version
To check the version of Cavalry you currently have installed you can run the version
command.
Typing ./cavalry-cli version -h
(macOS) or .\cavalry-cli version -h
(Windows) will output the following help information.
macOS
Windows
Will return the version of Cavalry installed.
Auth
You'll need to authenticate in order to use CLI to render. If you have used the main Cavalry application with a Professional licence recently then you will already be authenticated but in the event that you haven't, you can use the auth
command to do so.
Typing ./cavalry-cli auth -h
(macOS) or .\cavalry-cli auth -h
(Windows) followed by enter will output the following help information:
For example, the below will sign in using your email address (the one you use to sign in to Cavalry):
You will then be asked to enter your password.
Once authenticated, any Render commands will run .
Proxy
List
Only available on the Professional plan.
You can list additional information about your scene like the Composition and Render Queue item Ids. These can be added to the render
command as flags. Typing ./cavalry-cli list -h
(macOS) or .\cavalry-cli list -h
(Windows) followed by enter will output the following help information:
For example, the below will output information about all the compositions in that scene.
macOS
Windows
Hitting enter will return a list of the compositions in your scene and their IDs.
The Composition ID can then be used with the --composition
flag as part of a render
command. For example, if you wanted to render Composition 1 you would add --composition compNode#1
to the render command.
Glossary
INT - an integer is a number without a decimal point. e.g. 4
INT x 2 - a set of two integers to define a range. e.g. 4 8
(4[space]8
)
FLOAT - a float is a number that has a decimal place. e.g. 23.5
TEXT - a text string that can include letters, numbers, special characters, the dash symbol, or the number sign. e.g. sceneName-01
Last updated
Was this helpful?