cli → zoo → kcl

zoo kcl snapshot

Snapshot a render of a kcl file as any supported image format.

Options

input
The path to the input kcl file to snapshot. This can also be the path to a directory containing a main.kcl file. If you pass - as the path, the file will be read from stdin
output-file
The path to a file to output the image
-t/--output-format
A valid output image format
Possible values: png | jpeg
-f/--format
Command output format
Possible values: json | yaml | table
--session
If given, this command will reuse an existing KittyCAD modeling session. You can start the session via zoo session-start --listen-on 0.0.0.0:3333 in this CLI
--show-trace
If true, print a link to this request's tracing data
Default value: false
--replay
If true, tell engine to store a replay
Default value: false
-d/--debug
Print debug info
Default value: false
-h/--help
Print help (see a summary with '-h')

About

# snapshot as png
$ zoo kcl snapshot my-file.kcl my-file.png

# pass a file to snapshot from stdin
$ cat my-obj.kcl | zoo kcl snapshot --output-format=png - my-file.png

By default, this will search the input path for a project.toml file to determine any specific execution settings.

See also