How to use OpenToonz CLI


Did you know that OpenToonz have CLI tools? CLI stands for “command-line interface” and it might happen to be a big help to automate your tasks. Let me introduce you: “tcleanup”, “tcomposer”, “tconverter”, “tfarmcontroller” and “tfarmserver”.

If you compile OpenToonz from source, then CLI tools are installed to your system as separate binary files. But if you use our AppImage build, then you got only one single binary file – so, how to run those CLI tools?

Easy! Just call appimage binary with a special “–appimage-exec” option. For example, if you want to call “tconverter”, then do the following:

$ /path/to/OpenToonz.appimage --appimage-exec tconverter ARGUMENTS

Of course, make sure to replace ARGUMENTS with actual argument values.

For example, use “-help” to get syntax of “tconverter” tool:

$ /path/to/OpenToonz.appimage --appimage-exec tconverter -help
usage: tconverter -help
       tconverter -release
       tconverter srcName dstName [ -w width ] [ -s sceneName ] [ -range from to | -frame fr ]

       Print this help page
       Print the current Toonz version
  -w width
       Image width
  -s sceneName
       Scene file
  -range from to | -frame fr
       frame range
       Source file
       Target file

Note, that CLI functionality is not available with AppImage builds made prior to 2016-11-23. So, please make sure to use the most recent build.

Download latest version of OpenToonz

Posted in OpenToonz, OpenToonz Tutorials and tagged .

Leave a Reply