Bella CLI
Jump to:
Introduction

Bella CLI is a command-line application for automating the rendering of Bella scenes, and may therefore be used to create a render farm.

Scope of this Document

This document intends to explain specifically about the Bella CLI, not about general Bella concepts, for which you should refer to the core Bella and node definition documentation.

Installation

To install Bella CLI, download the package appropriate for you operating system (.zip for Windows, .dmg for MacOS) and follow these steps:

Windows

  1. Unzip the downloaded .zip file on your desktop.
  2. Double-click on the installer .exe file and follow the directions.

MacOS

  1. Double-click the downloaded .dmg to mount it.
  2. Drag bella_cli to the Applications folder.
Arguments

Following is a listing of currently-supported Bella CLI arguments:

$>bella_cli --help

Bella CLI 19.3.0.0, Copyright (c) 2019, Diffuse Logic

USAGE

    bella_cli [-i:path] [-o:path] [-v|-h|-i|-o|-mi|-li|-tp|-hg|-od|-on|-fbd|-fbn|-m|-f]

OPTIONS

    version

        -v [ --version ]
        /v [  /version ]

        NOTES: Print application version to the console.

    help

        -h [ --help ]
        /h [  /help ]
        /?

        NOTES: Print this help text.

    input

        -i: [ --input: ]
        /i: [  /input: ]

        NOTES: Input file path.

    output

        -o: [ --output: ]
        /o: [  /output: ]

        NOTES: Output file path.

    machineinfo

        -mi [ --machineinfo ]
        /mi [  /machineinfo ]

        NOTES: Print machine/os info and exit.

    licenseinfo

        -li [ --licenseinfo ]
        /li [  /licenseinfo ]

        NOTES: Print license info and exit.

    thirdparty

        -tp [ --thirdparty ]
        /tp [  /thirdparty ]

        NOTES: Print third-party licenses used by Bella and exit.

    helpgen

        -hg [ --helpgen ]
        /hg [  /helpgen ]

        NOTES: Generate html help from a .bnd file. If no input path is given, help will be generated for the built-in Bella node definitions. If no output path is given, the path of the input .bnd will be used (renamed to .html). If neither input nor output paths are given, the command will fail.

    outputDir

        -od [ --outputdir ]
        /od [  /outputdir ]

        NOTES: Override settings:outputDir in the rendered scene.

    outputName

        -on [ --outputname ]
        /on [  /outputname ]

        NOTES: Override settings:outputName in the rendered scene.

    finalBsiDir

        -fbd [ --finalbsidir ]
        /fbd [  /finalbsidir ]

        NOTES: A directory where local BSI files (saved as according to beautyPass:saveBsi) will be copied at end of rendering.

    finalBsiName

        -fbn [ --finalbsiname ]
        /fbn [  /finalbsiname ]

        NOTES: A custom name to use when copying BSI files to --finalBsiDir. Specify with or without the extension.

    merge

        -m [ --merge ]
        /m [  /merge ]

        NOTES: Merge a list of BSI files. Your must -o: to specify the output BSI.

    force

        -f [ --force ]
        /f [  /force ]

        NOTES: Force overwrite ( or other destructive action ), depending on the context.