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. 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

-s/--src-unit

The source unit to use for the kcl file. This defaults to millimeters, if not set and there is no project.toml. If there is a project.toml file, the default unit will be the one set in the project.toml file
Possible values: cm | ft | in | m | mm | yd

-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 the source unit and any specific execution settings. If no project.toml file is found, in the directory of the input path OR any parent directories above that, the default source unit will be millimeters. You can also specify the source unit with the --src-unit/-s command line flag.

See also

• zoo kcl