Command Reference¶
Most of Buildcat’s functionality can be accessed at the command line, using the following:
buildcat¶
Command line client for Buildcat: the portable, lightweight render farm.
usage: buildcat [-h] [--debug]
{certificate-info,client-keygen,client-tunnel,eta,houdini-info,houdini-render-ifd,houdini-render-hip,modo-info,modo-render,redshift-info,redshift-render,server,server-keygen,server-tunnel,worker,workers,worker-info,version}
...
Named Arguments¶
- --debug
Verbose logging output.
Default: False
commands (choose one)¶
- command
Possible choices: certificate-info, client-keygen, client-tunnel, eta, houdini-info, houdini-render-ifd, houdini-render-hip, modo-info, modo-render, redshift-info, redshift-render, server, server-keygen, server-tunnel, worker, workers, worker-info, version
Sub-commands¶
certificate-info¶
Display information about a TLS certificate.
buildcat certificate-info [-h] path
Positional Arguments¶
- path
Path to the certificate file.
client-keygen¶
Generate client key and certificate for TLS encryption.
buildcat client-keygen [-h] [--country COUNTRY] [--days DAYS] [--email EMAIL]
[--locality LOCALITY] [--name NAME]
[--organization ORGANIZATION] [--state STATE]
[--unit UNIT]
Named Arguments¶
- --country
Certificate country. Default: “US”
Default: “US”
- --days
Length of time the certificate will be valid. Default: 365
Default: 365
Certificate email. Default: None
- --locality
Certificate locality. Default: “Albuquerque”
Default: “Albuquerque”
- --name
Client name. Default: “*”
Default: “*”
- --organization
Certificate organization. Default: “Buildcat”
Default: “Buildcat”
- --state
Certificate state. Default: “New Mexico”
Default: “New Mexico”
- --unit
Certificate organizational unit. Default: None
client-tunnel¶
Create a forwarding TLS tunnel for Buildcat workers and clients.
buildcat client-tunnel [-h] [--host HOST] [--identity IDENTITY] [--peer PEER]
[--port PORT] [--tunnel-port TUNNEL_PORT]
Named Arguments¶
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --identity
Client private key and certificate. Default: “/home/docs/.buildcat/client.pem”
Default: “/home/docs/.buildcat/client.pem”
- --peer
Server certificate. Default: “/home/docs/.buildcat/server.cert”
Default: “/home/docs/.buildcat/server.cert”
- --port
Server port. Default: 4443
Default: 4443
- --tunnel-port
Listening port. Default: 6379
Default: 6379
eta¶
Estimate when a queue will empty.
buildcat eta [-h] [--count COUNT] [--host HOST] [--interval INTERVAL]
[--port PORT] [--queue QUEUE]
Named Arguments¶
- --count
Number of intervals to retain for the moving average. Default: 60
Default: 60
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --interval
Update interval in seconds. Default: 5
Default: 5
- --port
Server port. Default: 6379
Default: 6379
- --queue
Server queue to ping. Default: “default”
Default: “default”
houdini-info¶
Retrieve Houdini information from a worker.
buildcat houdini-info [-h] [--host HOST] [--port PORT] [--queue QUEUE]
Named Arguments¶
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --port
Server port. Default: 6379
Default: 6379
- --queue
Server queue to ping. Default: “default”
Default: “default”
houdini-render-ifd¶
Submit Houdini .ifd render jobs.
buildcat houdini-render-ifd [-h] [--host HOST] [--port PORT] [--queue QUEUE]
[--timeout TIMEOUT]
ifdfile [ifdfile ...]
Positional Arguments¶
- ifdfile
Houdini .ifd file(s) to render with mantra.
Named Arguments¶
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --port
Server port. Default: 6379
Default: 6379
- --queue
server queue to use for rendering. default: “default”
Default: “default”
- --timeout
Job timeout in seconds. default: 900
Default: 900
houdini-render-hip¶
Submit a Houdini .hip render job.
buildcat houdini-render-hip [-h] [--frames FRAMES] [--host HOST] [--port PORT]
[--queue QUEUE] [--rop ROP] [--timeout TIMEOUT]
hipfile
Positional Arguments¶
- hipfile
Houdini .hip file to render.
Named Arguments¶
- --frames
Frame(s) to render. Default: “1”
Default: “1”
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --port
Server port. Default: 6379
Default: 6379
- --queue
Server queue to use for rendering. Default: “default”
Default: “default”
- --rop
ROP to use for rendering. Default: “/out/mantra_ipr”
Default: “/out/mantra_ipr”
- --timeout
Job timeout in seconds. default: 900
Default: 900
modo-info¶
Retrieve Modo information from a worker.
buildcat modo-info [-h] [--host HOST] [--port PORT] [--queue QUEUE]
Named Arguments¶
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --port
Server port. Default: 6379
Default: 6379
- --queue
Server queue to ping. Default: “default”
Default: “default”
modo-render¶
Submit a Modo render job.
buildcat modo-render [-h] [--host HOST] [--port PORT] [--queue QUEUE]
[--start START] [--step STEP] [--stop STOP]
[--timeout TIMEOUT]
lxofile
Positional Arguments¶
- lxofile
Modo .lxo file to render.
Named Arguments¶
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --port
Server port. Default: 6379
Default: 6379
- --queue
Server queue to ping. Default: “default”
Default: “default”
- --start
First frame to render. Default: 0
Default: 0
- --step
Interval between rendered frames. Default: 1.
Default: 1
- --stop
One past the last frame to render. Default: 1
Default: 1
- --timeout
Job timeout in seconds. default: 900
Default: 900
redshift-info¶
Retrieve Redshift information from a worker.
buildcat redshift-info [-h] [--host HOST] [--port PORT] [--queue QUEUE]
Named Arguments¶
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --port
Server port. Default: 6379
Default: 6379
- --queue
Server queue to ping. Default: “default”
Default: “default”
redshift-render¶
Submit a Redshift render job.
buildcat redshift-render [-h] [--host HOST] [--port PORT] [--queue QUEUE]
[--timeout TIMEOUT]
rsfile
Positional Arguments¶
- rsfile
Redshift .rs file to render.
Named Arguments¶
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --port
Server port. Default: 6379
Default: 6379
- --queue
Server queue to use for rendering. Default: “default”
Default: “default”
- --timeout
Job timeout in seconds. default: 900
Default: 900
server¶
Start a Buildcat server.
buildcat server [-h] [--bind BIND] [--port PORT] [--storage STORAGE]
Named Arguments¶
- --bind
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --port
Server port. Default: 6379
Default: 6379
- --storage
Persistent storage location. Default: “buildcat.aof”
Default: “buildcat.aof”
server-keygen¶
Generate server key and certificate for TLS encryption.
buildcat server-keygen [-h] [--country COUNTRY] [--days DAYS] [--email EMAIL]
[--locality LOCALITY] [--name NAME]
[--organization ORGANIZATION] [--state STATE]
[--unit UNIT]
Named Arguments¶
- --country
Certificate country. Default: “US”
Default: “US”
- --days
Length of time the certificate will be valid. Default: 365
Default: 365
Certificate email. Default: None
- --locality
Certificate locality. Default: “Albuquerque”
Default: “Albuquerque”
- --name
Server name. Default: “127.0.0.1”
Default: “127.0.0.1”
- --organization
Certificate organization. Default: “Buildcat”
Default: “Buildcat”
- --state
Certificate state. Default: “New Mexico”
Default: “New Mexico”
- --unit
Certificate organizational unit. Default: None
server-tunnel¶
Create a listening TLS tunnel for the Buildcat server.
buildcat server-tunnel [-h] [--identity IDENTITY] [--peers PEERS]
[--port PORT] [--tunnel-port TUNNEL_PORT]
Named Arguments¶
- --identity
Server private key and certificate. Default: “/home/docs/.buildcat/server.pem”
Default: “/home/docs/.buildcat/server.pem”
- --peers
Allowed client certificates. Default: “/home/docs/.buildcat/client.cert”
Default: “/home/docs/.buildcat/client.cert”
- --port
Server port. Default: 6379
Default: 6379
- --tunnel-port
Listening port. Default: 4443
Default: 4443
worker¶
Start a Buildcat worker.
buildcat worker [-h] [--host HOST] [--max-jobs MAX_JOBS] [--no-fork]
[--port PORT] [--redshift-gpu REDSHIFT_GPU]
[queues [queues ...]]
Positional Arguments¶
- queues
Server queues to handle. Default: [‘default’]
Default: [‘default’]
Named Arguments¶
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --max-jobs
Maximum number of jobs to execute. Default: unlimited
- --no-fork
Use a non-forking worker for collecting code coverage.
Default: False
- --port
Server port. Default: 6379
Default: 6379
- --redshift-gpu
Specify GPU indices to use for Redshift rendering. Default: use all GPUs.
workers¶
Start multiple Buildcat workers.
buildcat workers [-h] [--count COUNT] [--host HOST] [--max-jobs MAX_JOBS]
[--no-fork] [--port PORT] [--redshift-gpu REDSHIFT_GPU]
[--session-name SESSION_NAME]
[queues [queues ...]]
Positional Arguments¶
- queues
Server queues to handle. Default: [‘default’]
Default: [‘default’]
Named Arguments¶
- --count, -n
Number of workers to start. Default: 1
Default: 1
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --max-jobs
Maximum number of jobs to execute. Default: unlimited
- --no-fork
Use non-forking workers for collecting code coverage.
Default: False
- --port
Server port. Default: 6379
Default: 6379
- --redshift-gpu
Specify GPU indices to use for Redshift rendering. Default: use all GPUs.
- --session-name, -s
tmux session name. Default: “buildcat-workers”
Default: “buildcat-workers”
worker-info¶
Retrieve information about a worker.
buildcat worker-info [-h] [--host HOST] [--port PORT] [--queue QUEUE]
Named Arguments¶
- --host
Server address. Default: “127.0.0.1”
Default: “127.0.0.1”
- --port
Server port. Default: 6379
Default: 6379
- --queue
Server queue. Default: “default”
Default: “default”
version¶
Print the version of this client.
buildcat version [-h]