cli → zoo → kcl

zoo kcl surface-area

Get the surface area of objects in a kcl file.

Options

input
The path to the input file. If you pass - as the path, the file will be read from stdin
-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
Output format
Possible values: json | yaml | table
-u/--output-unit
Output unit
Possible values: cm2 | dm2 | ft2 | in2 | km2 | m2 | mm2 | yd2
--show-trace
If true, print a link to this request's tracing data
Default value: false
-d/--debug
Print debug info
Default value: false
-h/--help
Print help (see a summary with '-h')

About

# get the surface-area of a file
$ zoo kcl surface-area --src-unit=m my-file.kcl

# pass a file from stdin
$ cat my-file.kcl | zoo kcl surface-area --src-unit=m

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