Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CLI docs for 0.2.97 #320

Merged
merged 1 commit into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions content/pages/docs/cli/manual/zoo_kcl_center-of-mass.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ Get the center of mass of objects in a kcl file.
<dt><code>input</code></dt>
<dd>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</dd>

<dt><code>-s/--src-unit</code></dt>
<dd>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<br/>Possible values: <code>cm | ft | in | m | mm | yd</code></dd>

<dt><code>-f/--format</code></dt>
<dd>Output format<br/>Possible values: <code>json | yaml | table</code></dd>

Expand All @@ -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

Expand Down
13 changes: 3 additions & 10 deletions content/pages/docs/cli/manual/zoo_kcl_density.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ Get the density of objects in a kcl file.
<dt><code>input</code></dt>
<dd>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</dd>

<dt><code>-s/--src-unit</code></dt>
<dd>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<br/>Possible values: <code>cm | ft | in | m | mm | yd</code></dd>

<dt><code>-m/--material-mass</code></dt>
<dd>Material mass</dd>

Expand Down Expand Up @@ -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

Expand Down
9 changes: 1 addition & 8 deletions content/pages/docs/cli/manual/zoo_kcl_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ Export a `kcl` file as any other supported CAD file format.
<dt><code>-t/--output-format</code></dt>
<dd>A valid output file format<br/>Possible values: <code>fbx | glb | gltf | obj | ply | step | stl</code></dd>

<dt><code>-s/--src-unit</code></dt>
<dd>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<br/>Possible values: <code>cm | ft | in | m | mm | yd</code></dd>

<dt><code>-f/--format</code></dt>
<dd>Command output format<br/>Possible values: <code>json | yaml | table</code></dd>

Expand Down Expand Up @@ -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

Expand Down
13 changes: 3 additions & 10 deletions content/pages/docs/cli/manual/zoo_kcl_mass.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ Get the mass of objects in a kcl file.
<dt><code>--material-density-unit</code></dt>
<dd>Material density unit<br/>Possible values: <code>lb-ft3 | kg-m3</code></dd>

<dt><code>-s/--src-unit</code></dt>
<dd>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<br/>Possible values: <code>cm | ft | in | m | mm | yd</code></dd>

<dt><code>-f/--format</code></dt>
<dd>Output format<br/>Possible values: <code>json | yaml | table</code></dd>

Expand All @@ -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

Expand Down
9 changes: 1 addition & 8 deletions content/pages/docs/cli/manual/zoo_kcl_snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ Snapshot a render of a `kcl` file as any supported image format.
<dt><code>-t/--output-format</code></dt>
<dd>A valid output image format<br/>Possible values: <code>png | jpeg</code></dd>

<dt><code>-s/--src-unit</code></dt>
<dd>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<br/>Possible values: <code>cm | ft | in | m | mm | yd</code></dd>

<dt><code>-f/--format</code></dt>
<dd>Command output format<br/>Possible values: <code>json | yaml | table</code></dd>

Expand Down Expand Up @@ -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

Expand Down
13 changes: 3 additions & 10 deletions content/pages/docs/cli/manual/zoo_kcl_surface-area.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ Get the surface area of objects in a kcl file.
<dt><code>input</code></dt>
<dd>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</dd>

<dt><code>-s/--src-unit</code></dt>
<dd>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<br/>Possible values: <code>cm | ft | in | m | mm | yd</code></dd>

<dt><code>-f/--format</code></dt>
<dd>Output format<br/>Possible values: <code>json | yaml | table</code></dd>

Expand All @@ -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

Expand Down
9 changes: 1 addition & 8 deletions content/pages/docs/cli/manual/zoo_kcl_view.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ View a render of a `kcl` file in your terminal.
<dt><code>input</code></dt>
<dd>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</dd>

<dt><code>-s/--src-unit</code></dt>
<dd>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<br/>Possible values: <code>cm | ft | in | m | mm | yd</code></dd>

<dt><code>-f/--format</code></dt>
<dd>Command output format<br/>Possible values: <code>json | yaml | table</code></dd>

Expand All @@ -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

Expand Down
13 changes: 3 additions & 10 deletions content/pages/docs/cli/manual/zoo_kcl_volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ Get the volume of an object in a kcl file.
<dt><code>-f/--format</code></dt>
<dd>Output format<br/>Possible values: <code>json | yaml | table</code></dd>

<dt><code>-s/--src-unit</code></dt>
<dd>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<br/>Possible values: <code>cm | ft | in | m | mm | yd</code></dd>

<dt><code>-u/--output-unit</code></dt>
<dd>Output unit<br/>Possible values: <code>cm3 | ft3 | in3 | m3 | yd3 | usfloz | usgal | l | ml</code></dd>

Expand All @@ -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

Expand Down