From 983e3589de20a970fe94cbd99fe63a4e043fa626 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 31 Jan 2025 21:37:28 +0000 Subject: [PATCH] YOYO NEW CLI DOCS FOR 0.2.97! --- .../pages/docs/cli/manual/zoo_kcl_center-of-mass.md | 13 +++---------- content/pages/docs/cli/manual/zoo_kcl_density.md | 13 +++---------- content/pages/docs/cli/manual/zoo_kcl_export.md | 9 +-------- content/pages/docs/cli/manual/zoo_kcl_mass.md | 13 +++---------- content/pages/docs/cli/manual/zoo_kcl_snapshot.md | 9 +-------- .../pages/docs/cli/manual/zoo_kcl_surface-area.md | 13 +++---------- content/pages/docs/cli/manual/zoo_kcl_view.md | 9 +-------- content/pages/docs/cli/manual/zoo_kcl_volume.md | 13 +++---------- 8 files changed, 18 insertions(+), 74 deletions(-) diff --git a/content/pages/docs/cli/manual/zoo_kcl_center-of-mass.md b/content/pages/docs/cli/manual/zoo_kcl_center-of-mass.md index b10d038..cf0c31f 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_center-of-mass.md +++ b/content/pages/docs/cli/manual/zoo_kcl_center-of-mass.md @@ -12,9 +12,6 @@ Get the center of mass of objects in a kcl file.
input
The path to the input file. 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
-
-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
@@ -36,17 +33,13 @@ Get the center of mass of objects in a kcl file. ``` # get the mass of a file -$ zoo kcl center-of-mass --src-unit=m my-file.kcl +$ zoo kcl center-of-mass my-file.kcl # pass a file from stdin -$ cat my-file.kcl | zoo kcl center-of-mass --src-unit=m +$ cat my-file.kcl | zoo kcl center-of-mass ``` -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. +By default, this will search the input path for a `project.toml` file to determine any specific execution settings. ### See also diff --git a/content/pages/docs/cli/manual/zoo_kcl_density.md b/content/pages/docs/cli/manual/zoo_kcl_density.md index ffbaa3c..5825f50 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_density.md +++ b/content/pages/docs/cli/manual/zoo_kcl_density.md @@ -12,9 +12,6 @@ Get the density of objects in a kcl file.
input
The path to the input file. 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
-
-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
-
-m/--material-mass
Material mass
@@ -42,17 +39,13 @@ Get the density of objects in a kcl file. ``` # get the density of a file -$ zoo kcl density --src-unit=m my-file.kcl +$ zoo kcl density my-file.kcl # pass a file from stdin -$ cat my-file.kcl | zoo kcl density --src-unit=m +$ cat my-file.kcl | zoo kcl density ``` -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. +By default, this will search the input path for a `project.toml` file to determine any specific execution settings. ### See also diff --git a/content/pages/docs/cli/manual/zoo_kcl_export.md b/content/pages/docs/cli/manual/zoo_kcl_export.md index 6e8c6c9..f1e70f3 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_export.md +++ b/content/pages/docs/cli/manual/zoo_kcl_export.md @@ -18,9 +18,6 @@ Export a `kcl` file as any other supported CAD file format.
-t/--output-format
A valid output file format
Possible values: fbx | glb | gltf | obj | ply | step | stl
-
-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
@@ -51,11 +48,7 @@ $ zoo kcl export --output-format=step my-obj.kcl . $ cat my-obj.kcl | zoo kcl export --output-format=step - output_dir ``` -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. +By default, this will search the input path for a `project.toml` file to determine any specific execution settings. ### See also diff --git a/content/pages/docs/cli/manual/zoo_kcl_mass.md b/content/pages/docs/cli/manual/zoo_kcl_mass.md index 1aa1d50..cb5f058 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_mass.md +++ b/content/pages/docs/cli/manual/zoo_kcl_mass.md @@ -18,9 +18,6 @@ Get the mass of objects in a kcl file.
--material-density-unit
Material density unit
Possible values: lb-ft3 | kg-m3
-
-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
@@ -42,17 +39,13 @@ Get the mass of objects in a kcl file. ``` # get the mass of a file -$ zoo kcl mass --src-unit=m my-file.kcl +$ zoo kcl mass my-file.kcl # pass a file from stdin -$ cat my-file.kcl | zoo kcl mass --src-unit=m +$ cat my-file.kcl | zoo kcl mass ``` -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. +By default, this will search the input path for a `project.toml` file to determine any specific execution settings. ### See also diff --git a/content/pages/docs/cli/manual/zoo_kcl_snapshot.md b/content/pages/docs/cli/manual/zoo_kcl_snapshot.md index a51709b..606af75 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_snapshot.md +++ b/content/pages/docs/cli/manual/zoo_kcl_snapshot.md @@ -18,9 +18,6 @@ Snapshot a render of a `kcl` file as any supported image format.
-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
@@ -51,11 +48,7 @@ $ zoo kcl snapshot my-file.kcl my-file.png $ 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. +By default, this will search the input path for a `project.toml` file to determine any specific execution settings. ### See also diff --git a/content/pages/docs/cli/manual/zoo_kcl_surface-area.md b/content/pages/docs/cli/manual/zoo_kcl_surface-area.md index 3771214..5f2d197 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_surface-area.md +++ b/content/pages/docs/cli/manual/zoo_kcl_surface-area.md @@ -12,9 +12,6 @@ Get the surface area of objects in a kcl file.
input
The path to the input file. 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
-
-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
@@ -36,17 +33,13 @@ Get the surface area of objects in a kcl file. ``` # get the surface-area of a file -$ zoo kcl surface-area --src-unit=m my-file.kcl +$ zoo kcl surface-area my-file.kcl # pass a file from stdin -$ cat my-file.kcl | zoo kcl surface-area --src-unit=m +$ cat my-file.kcl | zoo kcl surface-area ``` -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. +By default, this will search the input path for a `project.toml` file to determine any specific execution settings. ### See also diff --git a/content/pages/docs/cli/manual/zoo_kcl_view.md b/content/pages/docs/cli/manual/zoo_kcl_view.md index f257381..37a79a5 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_view.md +++ b/content/pages/docs/cli/manual/zoo_kcl_view.md @@ -12,9 +12,6 @@ View a render of a `kcl` file in your terminal.
input
The path to the input kcl file to view. 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
-
-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
@@ -35,11 +32,7 @@ $ zoo kcl view my-file.kcl $ cat my-obj.kcl | zoo kcl view - ``` -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. +By default, this will search the input path for a `project.toml` file to determine any specific execution settings. ### See also diff --git a/content/pages/docs/cli/manual/zoo_kcl_volume.md b/content/pages/docs/cli/manual/zoo_kcl_volume.md index de9ba60..027a5dc 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_volume.md +++ b/content/pages/docs/cli/manual/zoo_kcl_volume.md @@ -15,9 +15,6 @@ Get the volume of an object in a kcl file.
-f/--format
Output format
Possible values: json | yaml | table
-
-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
-
-u/--output-unit
Output unit
Possible values: cm3 | ft3 | in3 | m3 | yd3 | usfloz | usgal | l | ml
@@ -36,17 +33,13 @@ Get the volume of an object in a kcl file. ``` # get the volume of a file -$ zoo kcl volume --src-unit=m my-file.kcl +$ zoo kcl volume my-file.kcl # pass a file from stdin -$ cat my-file.kcl | zoo kcl volume --src-unit=m +$ cat my-file.kcl | zoo kcl volume ``` -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. +By default, this will search the input path for a `project.toml` file to determine any specific execution settings. ### See also