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

--allow-errors

When there are KCL problems that are are errors, continue anyway. Problems (AKA compilation issues) may be detected in KCL parsing or execution and can have varying severity. Some errors are fatal and are not affected by this option. Which errors are considered fatal may change without notice
Default value: false

--angle

Which angle to take the snapshot from. Defaults to "front"
Possible values: front | top | right-side | four-ways | iso

--camera-style

Which style of camera to use for snapshots
Possible values: ortho | perspective
Default value: ortho

--camera-padding

How much padding to use when zooming before the screenshot. Positive padding will zoom out, negative padding will zoom in (and therefore crop). e.g. padding = 0.2 means the view will span 120% of the object(s) bounding box, and padding = -0.2 means the view will span 80% of the object(s) bounding box
Default value: 0.1

-d/--debug

Print debug info
Default value: false

--host

Zoo API host to use for all commands (e.g., "api.zoo.dev" or "http://localhost:8888"). Overrides the configured default host

-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

• zoo kcl