From dbcb9d49992cddec031a5281bac4b647bfd5f0d4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 11 Mar 2026 21:13:10 +0000 Subject: [PATCH] YOYO NEW CLI DOCS FOR 0.2.150! --- content/pages/docs/cli/manual/zoo_api-call.md | 8 ++-- .../docs/cli/manual/zoo_api-call_status.md | 8 ++-- content/pages/docs/cli/manual/zoo_app.md | 13 +++--- .../pages/docs/cli/manual/zoo_auth_login.md | 25 +++++----- .../pages/docs/cli/manual/zoo_auth_logout.md | 13 +++--- .../pages/docs/cli/manual/zoo_completion.md | 34 ++++++-------- content/pages/docs/cli/manual/zoo_drake.md | 6 +-- content/pages/docs/cli/manual/zoo_file.md | 8 ++-- .../cli/manual/zoo_file_center-of-mass.md | 13 +++--- .../pages/docs/cli/manual/zoo_file_convert.md | 21 ++++----- .../pages/docs/cli/manual/zoo_file_density.md | 13 +++--- .../pages/docs/cli/manual/zoo_file_mass.md | 13 +++--- .../docs/cli/manual/zoo_file_snapshot.md | 12 ++--- .../docs/cli/manual/zoo_file_surface-area.md | 13 +++--- .../pages/docs/cli/manual/zoo_file_volume.md | 13 +++--- content/pages/docs/cli/manual/zoo_kcl.md | 1 + .../pages/docs/cli/manual/zoo_kcl_analyze.md | 13 +++--- .../docs/cli/manual/zoo_kcl_bounding-box.md | 46 +++++++++++++++++++ .../docs/cli/manual/zoo_kcl_center-of-mass.md | 12 ++--- .../pages/docs/cli/manual/zoo_kcl_density.md | 12 ++--- .../pages/docs/cli/manual/zoo_kcl_export.md | 18 ++++---- .../pages/docs/cli/manual/zoo_kcl_format.md | 18 ++++---- content/pages/docs/cli/manual/zoo_kcl_lint.md | 12 ++--- content/pages/docs/cli/manual/zoo_kcl_mass.md | 12 ++--- .../pages/docs/cli/manual/zoo_kcl_snapshot.md | 14 +++--- .../docs/cli/manual/zoo_kcl_surface-area.md | 12 ++--- content/pages/docs/cli/manual/zoo_kcl_view.md | 12 ++--- .../pages/docs/cli/manual/zoo_kcl_volume.md | 12 ++--- .../docs/cli/manual/zoo_ml_kcl_copilot.md | 5 +- .../pages/docs/cli/manual/zoo_ml_kcl_edit.md | 6 +-- .../cli/manual/zoo_ml_text-to-cad_export.md | 6 +-- .../cli/manual/zoo_ml_text-to-cad_snapshot.md | 8 ++-- .../cli/manual/zoo_ml_text-to-cad_view.md | 6 +-- content/pages/docs/cli/manual/zoo_open.md | 13 +++--- content/pages/docs/cli/manual/zoo_say.md | 10 ++-- 35 files changed, 245 insertions(+), 216 deletions(-) create mode 100644 content/pages/docs/cli/manual/zoo_kcl_bounding-box.md diff --git a/content/pages/docs/cli/manual/zoo_api-call.md b/content/pages/docs/cli/manual/zoo_api-call.md index f47df7ad..945cc159 100644 --- a/content/pages/docs/cli/manual/zoo_api-call.md +++ b/content/pages/docs/cli/manual/zoo_api-call.md @@ -26,7 +26,7 @@ Perform operations on CAD files. ### About -``` -# convert a step file to an obj file -$ zoo file convert ./input.step ./output.obj -``` \ No newline at end of file + + # convert a step file to an obj file + $ zoo file convert ./input.step ./output.obj + \ No newline at end of file diff --git a/content/pages/docs/cli/manual/zoo_api-call_status.md b/content/pages/docs/cli/manual/zoo_api-call_status.md index 21ab1fd5..9dd85335 100644 --- a/content/pages/docs/cli/manual/zoo_api-call_status.md +++ b/content/pages/docs/cli/manual/zoo_api-call_status.md @@ -28,10 +28,10 @@ Perform operations for API calls. ### About -``` -# get the status of an async API call -$ zoo api-call status -``` + + # get the status of an async API call + $ zoo api-call status + ### See also diff --git a/content/pages/docs/cli/manual/zoo_app.md b/content/pages/docs/cli/manual/zoo_app.md index c3e4c899..4ffeb2c7 100644 --- a/content/pages/docs/cli/manual/zoo_app.md +++ b/content/pages/docs/cli/manual/zoo_app.md @@ -27,10 +27,9 @@ Open a directory or file in the Zoo Design Studio on your desktop. If you do not have the app installed, you will be prompted to download it. -``` -$ zoo app . - -$ zoo app main.kcl - -$ zoo app ../main.kcl -``` \ No newline at end of file + $ zoo app . + + $ zoo app main.kcl + + $ zoo app ../main.kcl + \ No newline at end of file diff --git a/content/pages/docs/cli/manual/zoo_auth_login.md b/content/pages/docs/cli/manual/zoo_auth_login.md index c91106c5..bac10e7f 100644 --- a/content/pages/docs/cli/manual/zoo_auth_login.md +++ b/content/pages/docs/cli/manual/zoo_auth_login.md @@ -30,19 +30,18 @@ Authenticate with an Zoo host. Alternatively, pass in a token on standard input by using `--with-token`. -``` -# start interactive setup -$ zoo auth login - -# authenticate against a specific Zoo instance by reading the token from a file -$ zoo --host zoo.internal auth login --with-token < mytoken.txt - -# authenticate with a specific Zoo instance -$ zoo --host zoo.internal auth login - -# authenticate with an insecure Zoo instance (not recommended) -$ zoo --host http://zoo.internal auth login -``` + # start interactive setup + $ zoo auth login + + # authenticate against a specific Zoo instance by reading the token from a file + $ zoo --host zoo.internal auth login --with-token < mytoken.txt + + # authenticate with a specific Zoo instance + $ zoo --host zoo.internal auth login + + # authenticate with an insecure Zoo instance (not recommended) + $ zoo --host http://zoo.internal auth login + ### See also diff --git a/content/pages/docs/cli/manual/zoo_auth_logout.md b/content/pages/docs/cli/manual/zoo_auth_logout.md index db8c7a8c..433f8914 100644 --- a/content/pages/docs/cli/manual/zoo_auth_logout.md +++ b/content/pages/docs/cli/manual/zoo_auth_logout.md @@ -25,13 +25,12 @@ Log out of an Zoo host. This command removes the authentication configuration for a host either specified interactively or via the global `--host` passed to `zoo`. -``` -$ zoo auth logout -# => select what host to log out of via a prompt - -$ zoo --host zoo.internal auth logout -# => log out of specified host -``` + $ zoo auth logout + # => select what host to log out of via a prompt + + $ zoo --host zoo.internal auth logout + # => log out of specified host + ### See also diff --git a/content/pages/docs/cli/manual/zoo_completion.md b/content/pages/docs/cli/manual/zoo_completion.md index db38791f..90eea83a 100644 --- a/content/pages/docs/cli/manual/zoo_completion.md +++ b/content/pages/docs/cli/manual/zoo_completion.md @@ -39,24 +39,21 @@ First, ensure that you install `bash-completion` using your package manager. After, add this to your `~/.bash_profile`: -``` -eval "$(zoo completion -s bash)" -``` + eval "$(zoo completion -s bash)" + ### zsh Generate a `_zoo` completion script and put it somewhere in your `$fpath`: -``` -zoo completion -s zsh > /usr/local/share/zsh/site-functions/_zoo -``` + zoo completion -s zsh > /usr/local/share/zsh/site-functions/_zoo + Ensure that the following is present in your `~/.zshrc`: -``` -autoload -U compinit -compinit -i -``` + autoload -U compinit + compinit -i + Zsh version 5.7 or later is recommended. @@ -64,21 +61,18 @@ Zsh version 5.7 or later is recommended. Generate a `zoo.fish` completion script: -``` -zoo completion -s fish > ~/.config/fish/completions/zoo.fish -``` + zoo completion -s fish > ~/.config/fish/completions/zoo.fish + ### PowerShell Open your profile script with: -``` -mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue -notepad $profile -``` + mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue + notepad $profile + Add the line and save the file: -``` -Invoke-Expression -Command $(zoo completion -s powershell | Out-String) -``` \ No newline at end of file + Invoke-Expression -Command $(zoo completion -s powershell | Out-String) + \ No newline at end of file diff --git a/content/pages/docs/cli/manual/zoo_drake.md b/content/pages/docs/cli/manual/zoo_drake.md index f6dd976d..d475ee84 100644 --- a/content/pages/docs/cli/manual/zoo_drake.md +++ b/content/pages/docs/cli/manual/zoo_drake.md @@ -22,6 +22,6 @@ Open a drake meme in your web browser. ### About -``` -$ zoo drake -``` \ No newline at end of file + + $ zoo drake + \ No newline at end of file diff --git a/content/pages/docs/cli/manual/zoo_file.md b/content/pages/docs/cli/manual/zoo_file.md index fac1cbed..34e6feb2 100644 --- a/content/pages/docs/cli/manual/zoo_file.md +++ b/content/pages/docs/cli/manual/zoo_file.md @@ -32,7 +32,7 @@ Perform operations on CAD files. ### About -``` -# convert a step file to an obj file -$ zoo file convert --output-format=obj ./input.step ./ -``` \ No newline at end of file + + # convert a step file to an obj file + $ zoo file convert --output-format=obj ./input.step ./ + \ No newline at end of file diff --git a/content/pages/docs/cli/manual/zoo_file_center-of-mass.md b/content/pages/docs/cli/manual/zoo_file_center-of-mass.md index 9ccdfb3c..10c8dd46 100644 --- a/content/pages/docs/cli/manual/zoo_file_center-of-mass.md +++ b/content/pages/docs/cli/manual/zoo_file_center-of-mass.md @@ -38,13 +38,12 @@ If the input file is larger than a certain size it will be performed asynchronously, you can then check the status with the `zoo api-call status ` command. -``` -# get the mass of a file -$ zoo file center-of-mass my-file.step - -# pass a file from stdin, the original file type is required -$ cat my-obj.obj | zoo file center-of-mass - --src-format=obj -``` + # get the mass of a file + $ zoo file center-of-mass my-file.step + + # pass a file from stdin, the original file type is required + $ cat my-obj.obj | zoo file center-of-mass - --src-format=obj + ### See also diff --git a/content/pages/docs/cli/manual/zoo_file_convert.md b/content/pages/docs/cli/manual/zoo_file_convert.md index 969c5ba0..319a4985 100644 --- a/content/pages/docs/cli/manual/zoo_file_convert.md +++ b/content/pages/docs/cli/manual/zoo_file_convert.md @@ -44,17 +44,16 @@ If the file being converted is larger than a certain size it will be performed asynchronously, you can then check its status with the `zoo api-call status ` command. -``` -# convert step to obj -$ zoo file convert --output-format=obj my-file.step output_dir - -# convert obj to step -$ zoo file convert --output-format=step my-obj.obj . - -# pass a file to convert from stdin -# when converting from stdin, the original file type is required -$ cat my-obj.obj | zoo file convert --output-format=step - output_dir -``` + # convert step to obj + $ zoo file convert --output-format=obj my-file.step output_dir + + # convert obj to step + $ zoo file convert --output-format=step my-obj.obj . + + # pass a file to convert from stdin + # when converting from stdin, the original file type is required + $ cat my-obj.obj | zoo file convert --output-format=step - output_dir + ### See also diff --git a/content/pages/docs/cli/manual/zoo_file_density.md b/content/pages/docs/cli/manual/zoo_file_density.md index 98eeb65b..97ac5f8e 100644 --- a/content/pages/docs/cli/manual/zoo_file_density.md +++ b/content/pages/docs/cli/manual/zoo_file_density.md @@ -44,13 +44,12 @@ If the input file is larger than a certain size it will be performed asynchronously, you can then check the status with the `zoo api-call status ` command. -``` -# get the density of a file -$ zoo file density my-file.step - -# pass a file from stdin, the original file type is required -$ cat my-obj.obj | zoo file density - --src-format=obj -``` + # get the density of a file + $ zoo file density my-file.step + + # pass a file from stdin, the original file type is required + $ cat my-obj.obj | zoo file density - --src-format=obj + ### See also diff --git a/content/pages/docs/cli/manual/zoo_file_mass.md b/content/pages/docs/cli/manual/zoo_file_mass.md index cb2265c3..136c56f3 100644 --- a/content/pages/docs/cli/manual/zoo_file_mass.md +++ b/content/pages/docs/cli/manual/zoo_file_mass.md @@ -44,13 +44,12 @@ If the input file is larger than a certain size it will be performed asynchronously, you can then check the status with the `zoo api-call status ` command. -``` -# get the mass of a file -$ zoo file mass my-file.step - -# pass a file from stdin, the original file type is required -$ cat my-obj.obj | zoo file mass - --src-format=obj -``` + # get the mass of a file + $ zoo file mass my-file.step + + # pass a file from stdin, the original file type is required + $ cat my-obj.obj | zoo file mass - --src-format=obj + ### See also diff --git a/content/pages/docs/cli/manual/zoo_file_snapshot.md b/content/pages/docs/cli/manual/zoo_file_snapshot.md index beeffa39..7f27dbd1 100644 --- a/content/pages/docs/cli/manual/zoo_file_snapshot.md +++ b/content/pages/docs/cli/manual/zoo_file_snapshot.md @@ -37,13 +37,13 @@ Snapshot a render of a CAD file as any supported image format. ### About -``` -# snapshot as png -$ zoo file snapshot my-file.obj my-file.png -# pass a file to snapshot from stdin -$ cat my-obj.obj | zoo file snapshot --output-format=png - my-file.png -``` + # snapshot as png + $ zoo file snapshot my-file.obj my-file.png + + # pass a file to snapshot from stdin + $ cat my-obj.obj | zoo file snapshot --output-format=png - my-file.png + ### See also diff --git a/content/pages/docs/cli/manual/zoo_file_surface-area.md b/content/pages/docs/cli/manual/zoo_file_surface-area.md index 7bd5a91a..c5ff4732 100644 --- a/content/pages/docs/cli/manual/zoo_file_surface-area.md +++ b/content/pages/docs/cli/manual/zoo_file_surface-area.md @@ -38,13 +38,12 @@ If the input file is larger than a certain size it will be performed asynchronously, you can then check the status with the `zoo api-call status ` command. -``` -# get the surface-area of a file -$ zoo file surface-area my-file.step - -# pass a file from stdin, the original file type is required -$ cat my-obj.obj | zoo file surface-area - --src-format=obj -``` + # get the surface-area of a file + $ zoo file surface-area my-file.step + + # pass a file from stdin, the original file type is required + $ cat my-obj.obj | zoo file surface-area - --src-format=obj + ### See also diff --git a/content/pages/docs/cli/manual/zoo_file_volume.md b/content/pages/docs/cli/manual/zoo_file_volume.md index b6050816..f7d437a9 100644 --- a/content/pages/docs/cli/manual/zoo_file_volume.md +++ b/content/pages/docs/cli/manual/zoo_file_volume.md @@ -38,13 +38,12 @@ If the input file is larger than a certain size it will be performed asynchronously, you can then check the status with the `zoo api-call status ` command. -``` -# get the volume of a file -$ zoo file volume my-file.step - -# pass a file from stdin, the original file type is required -$ cat my-obj.obj | zoo file volume - --src-format=obj -``` + # get the volume of a file + $ zoo file volume my-file.step + + # pass a file from stdin, the original file type is required + $ cat my-obj.obj | zoo file volume - --src-format=obj + ### See also diff --git a/content/pages/docs/cli/manual/zoo_kcl.md b/content/pages/docs/cli/manual/zoo_kcl.md index 5b27d9ea..2e0bfd76 100644 --- a/content/pages/docs/cli/manual/zoo_kcl.md +++ b/content/pages/docs/cli/manual/zoo_kcl.md @@ -19,6 +19,7 @@ Perform actions on `kcl` files. * [zoo kcl density](./zoo_kcl_density) * [zoo kcl surface-area](./zoo_kcl_surface-area) * [zoo kcl lint](./zoo_kcl_lint) +* [zoo kcl bounding-box](./zoo_kcl_bounding-box) ### Options diff --git a/content/pages/docs/cli/manual/zoo_kcl_analyze.md b/content/pages/docs/cli/manual/zoo_kcl_analyze.md index ddc17140..6896285c 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_analyze.md +++ b/content/pages/docs/cli/manual/zoo_kcl_analyze.md @@ -54,13 +54,12 @@ Analyze multiple physical properties of objects in a kcl file. This runs KCL once and then returns all requested analyses from the same scene. -``` -# analyze a file and print a table -$ zoo kcl analyze my-file.kcl --material-density 1.0 --material-density-unit lb-ft3 - -# output for scripting -$ zoo kcl analyze my-file.kcl --format json --material-density 1.0 --material-density-unit lb-ft3 -``` + # analyze a file and print a table + $ zoo kcl analyze my-file.kcl --material-density 1.0 --material-density-unit lb-ft3 + + # output for scripting + $ zoo kcl analyze my-file.kcl --format json --material-density 1.0 --material-density-unit lb-ft3 + By default, this will search the input path for a `project.toml` file to determine any specific execution settings. diff --git a/content/pages/docs/cli/manual/zoo_kcl_bounding-box.md b/content/pages/docs/cli/manual/zoo_kcl_bounding-box.md new file mode 100644 index 00000000..55d4bdfc --- /dev/null +++ b/content/pages/docs/cli/manual/zoo_kcl_bounding-box.md @@ -0,0 +1,46 @@ +--- +title: "zoo kcl bounding-box" +excerpt: "Get the bounding box that contains everything in a KCL file." +layout: manual +--- + +Get the bounding box that contains everything in a KCL file. + +### Options + +
+
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
+ +
-f/--format
+
Output format
Possible values: json | yaml | table
+ +
-u/--output-unit
+
Output unit
+ +
-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 + + + # get the volume of a file + $ zoo kcl bounding-box my-file.kcl + + # pass a file from stdin + $ cat my-file.kcl | zoo kcl bounding-box + + +By default, this will search the input path for a `project.toml` file to determine any specific execution settings. + +### See also + +* [zoo kcl](./zoo_kcl) \ No newline at end of file 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 c09d8c88..c65e51dc 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 @@ -34,13 +34,13 @@ Get the center of mass of objects in a kcl file. ### About -``` -# get the mass of a file -$ zoo kcl center-of-mass my-file.kcl -# pass a file from stdin -$ cat my-file.kcl | zoo kcl center-of-mass -``` + # get the mass of a file + $ zoo kcl center-of-mass my-file.kcl + + # pass a file from stdin + $ cat my-file.kcl | zoo kcl center-of-mass + By default, this will search the input path for a `project.toml` file to determine any specific execution settings. diff --git a/content/pages/docs/cli/manual/zoo_kcl_density.md b/content/pages/docs/cli/manual/zoo_kcl_density.md index 633e07f9..68e8d663 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_density.md +++ b/content/pages/docs/cli/manual/zoo_kcl_density.md @@ -40,13 +40,13 @@ Get the density of objects in a kcl file. ### About -``` -# get the density of a file -$ zoo kcl density my-file.kcl -# pass a file from stdin -$ cat my-file.kcl | zoo kcl density -``` + # get the density of a file + $ zoo kcl density my-file.kcl + + # pass a file from stdin + $ cat my-file.kcl | zoo kcl density + By default, this will search the input path for a `project.toml` file to determine any specific execution settings. diff --git a/content/pages/docs/cli/manual/zoo_kcl_export.md b/content/pages/docs/cli/manual/zoo_kcl_export.md index fd8088d3..f2ec4dae 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_export.md +++ b/content/pages/docs/cli/manual/zoo_kcl_export.md @@ -40,16 +40,16 @@ Export a `kcl` file as any other supported CAD file format. ### About -``` -# convert kcl to obj -$ zoo kcl export --output-format=obj my-file.kcl output_dir -# convert kcl to step -$ zoo kcl export --output-format=step my-obj.kcl . - -# pass a file to convert from stdin -$ cat my-obj.kcl | zoo kcl export --output-format=step - output_dir -``` + # convert kcl to obj + $ zoo kcl export --output-format=obj my-file.kcl output_dir + + # convert kcl to step + $ zoo kcl export --output-format=step my-obj.kcl . + + # pass a file to convert from stdin + $ 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 any specific execution settings. diff --git a/content/pages/docs/cli/manual/zoo_kcl_format.md b/content/pages/docs/cli/manual/zoo_kcl_format.md index 1ee91869..e8daa0c1 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_format.md +++ b/content/pages/docs/cli/manual/zoo_kcl_format.md @@ -40,16 +40,16 @@ Format a `kcl` file. ### About -``` -# Output to stdout by default -$ zoo kcl fmt my-file.kcl -# Overwrite the file -$ zoo kcl fmt -w my-file.kcl - -# Pass a file to format from stdin -$ cat my-obj.kcl | zoo kcl fmt -``` + # Output to stdout by default + $ zoo kcl fmt my-file.kcl + + # Overwrite the file + $ zoo kcl fmt -w my-file.kcl + + # Pass a file to format from stdin + $ cat my-obj.kcl | zoo kcl fmt + ### See also diff --git a/content/pages/docs/cli/manual/zoo_kcl_lint.md b/content/pages/docs/cli/manual/zoo_kcl_lint.md index 99915576..29bfc30c 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_lint.md +++ b/content/pages/docs/cli/manual/zoo_kcl_lint.md @@ -31,13 +31,13 @@ Lint a KCL file for style issues. ### About -``` -# check a file for issues -$ zoo kcl lint my-file.kcl -# pass a file from stdin -$ cat my-file.kcl | zoo kcl lint - -``` + # check a file for issues + $ zoo kcl lint my-file.kcl + + # pass a file from stdin + $ cat my-file.kcl | zoo kcl lint - + ### 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 e7c33aa7..a36bf4a5 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_mass.md +++ b/content/pages/docs/cli/manual/zoo_kcl_mass.md @@ -40,13 +40,13 @@ Get the mass of objects in a kcl file. ### About -``` -# get the mass of a file -$ zoo kcl mass my-file.kcl -# pass a file from stdin -$ cat my-file.kcl | zoo kcl mass -``` + # get the mass of a file + $ zoo kcl mass my-file.kcl + + # pass a file from stdin + $ cat my-file.kcl | zoo kcl mass + By default, this will search the input path for a `project.toml` file to determine any specific execution settings. diff --git a/content/pages/docs/cli/manual/zoo_kcl_snapshot.md b/content/pages/docs/cli/manual/zoo_kcl_snapshot.md index 3e016b62..2a08357e 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_snapshot.md +++ b/content/pages/docs/cli/manual/zoo_kcl_snapshot.md @@ -31,7 +31,7 @@ Snapshot a render of a `kcl` file as any supported image format.
If true, tell engine to store a replay
Default value: false
--angle
-
Which angle to take the snapshot from. Defaults to "front"
Possible values: front | top | right-side | four-ways
+
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
@@ -52,13 +52,13 @@ Snapshot a render of a `kcl` file as any supported image format. ### 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 -``` + # 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. 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 418f9937..b15fcbd9 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_surface-area.md +++ b/content/pages/docs/cli/manual/zoo_kcl_surface-area.md @@ -34,13 +34,13 @@ Get the surface area of objects in a kcl file. ### About -``` -# get the surface-area of a file -$ zoo kcl surface-area my-file.kcl -# pass a file from stdin -$ cat my-file.kcl | zoo kcl surface-area -``` + # get the surface-area of a file + $ zoo kcl surface-area my-file.kcl + + # pass a file from stdin + $ cat my-file.kcl | zoo kcl surface-area + By default, this will search the input path for a `project.toml` file to determine any specific execution settings. diff --git a/content/pages/docs/cli/manual/zoo_kcl_view.md b/content/pages/docs/cli/manual/zoo_kcl_view.md index ae24d1bf..97ad4b07 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_view.md +++ b/content/pages/docs/cli/manual/zoo_kcl_view.md @@ -16,7 +16,7 @@ View a render of a `kcl` file in your terminal.
Command output format
Possible values: json | yaml | table
--angle
-
Which angle to take the snapshot from. Defaults to "front"
Possible values: front | top | right-side | four-ways
+
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
@@ -37,12 +37,12 @@ View a render of a `kcl` file in your terminal. ### About -``` -$ zoo kcl view my-file.kcl -# pass a file to view from stdin -$ cat my-obj.kcl | zoo kcl view - -``` + $ zoo kcl view my-file.kcl + + # pass a file to view from stdin + $ cat my-obj.kcl | zoo kcl view - + By default, this will search the input path for a `project.toml` file to determine any specific execution settings. diff --git a/content/pages/docs/cli/manual/zoo_kcl_volume.md b/content/pages/docs/cli/manual/zoo_kcl_volume.md index b8ce30f4..8b84f31f 100644 --- a/content/pages/docs/cli/manual/zoo_kcl_volume.md +++ b/content/pages/docs/cli/manual/zoo_kcl_volume.md @@ -34,13 +34,13 @@ Get the volume of an object in a kcl file. ### About -``` -# get the volume of a file -$ zoo kcl volume my-file.kcl -# pass a file from stdin -$ cat my-file.kcl | zoo kcl volume -``` + # get the volume of a file + $ zoo kcl volume my-file.kcl + + # pass a file from stdin + $ cat my-file.kcl | zoo kcl volume + By default, this will search the input path for a `project.toml` file to determine any specific execution settings. diff --git a/content/pages/docs/cli/manual/zoo_ml_kcl_copilot.md b/content/pages/docs/cli/manual/zoo_ml_kcl_copilot.md index 1f0ca621..94aada73 100644 --- a/content/pages/docs/cli/manual/zoo_ml_kcl_copilot.md +++ b/content/pages/docs/cli/manual/zoo_ml_kcl_copilot.md @@ -27,9 +27,8 @@ Start an interactive Copilot chat for KCL in the current project directory. Requires the current directory to contain a `main.kcl` file. -``` -$ zoo ml kcl copilot -``` + $ zoo ml kcl copilot + ### Slash Commands diff --git a/content/pages/docs/cli/manual/zoo_ml_kcl_edit.md b/content/pages/docs/cli/manual/zoo_ml_kcl_edit.md index 1dacc357..5255f0e1 100644 --- a/content/pages/docs/cli/manual/zoo_ml_kcl_edit.md +++ b/content/pages/docs/cli/manual/zoo_ml_kcl_edit.md @@ -34,9 +34,9 @@ Edit `kcl` file(s) with a prompt. ### About -``` -$ zoo ml kcl edit --prompt "Make it blue" -``` + + $ zoo ml kcl edit --prompt "Make it blue" + This command outputs the edited `kcl` files back to the same location. We do not output to stdout, because for projects with multiple files, diff --git a/content/pages/docs/cli/manual/zoo_ml_text-to-cad_export.md b/content/pages/docs/cli/manual/zoo_ml_text-to-cad_export.md index ca10fa01..78f2a695 100644 --- a/content/pages/docs/cli/manual/zoo_ml_text-to-cad_export.md +++ b/content/pages/docs/cli/manual/zoo_ml_text-to-cad_export.md @@ -37,9 +37,9 @@ Run a Text-to-CAD prompt and export it as any other supported CAD file format. ### About -``` -$ zoo ml text-to-cad export --output-format=obj A 2x4 lego brick -``` + + $ zoo ml text-to-cad export --output-format=obj A 2x4 lego brick + ### See also diff --git a/content/pages/docs/cli/manual/zoo_ml_text-to-cad_snapshot.md b/content/pages/docs/cli/manual/zoo_ml_text-to-cad_snapshot.md index fee1c883..bd6647de 100644 --- a/content/pages/docs/cli/manual/zoo_ml_text-to-cad_snapshot.md +++ b/content/pages/docs/cli/manual/zoo_ml_text-to-cad_snapshot.md @@ -37,10 +37,10 @@ Snapshot a render of a Text-to-CAD prompt as any supported image format. ### About -``` -# snapshot as png -$ zoo ml text-to-cad snapshot A 2x4 lego brick -``` + + # snapshot as png + $ zoo ml text-to-cad snapshot A 2x4 lego brick + ### See also diff --git a/content/pages/docs/cli/manual/zoo_ml_text-to-cad_view.md b/content/pages/docs/cli/manual/zoo_ml_text-to-cad_view.md index 172242c8..fcb8bae4 100644 --- a/content/pages/docs/cli/manual/zoo_ml_text-to-cad_view.md +++ b/content/pages/docs/cli/manual/zoo_ml_text-to-cad_view.md @@ -31,9 +31,9 @@ View a render of a Text-to-CAD prompt in your terminal. ### About -``` -$ zoo ml text-to-cad view A 2x4 lego brick -``` + + $ zoo ml text-to-cad view A 2x4 lego brick + ### See also diff --git a/content/pages/docs/cli/manual/zoo_open.md b/content/pages/docs/cli/manual/zoo_open.md index 5728a6c9..0768c38a 100644 --- a/content/pages/docs/cli/manual/zoo_open.md +++ b/content/pages/docs/cli/manual/zoo_open.md @@ -27,10 +27,9 @@ Shortcut to open the Zoo documentation or Account in your browser. If no arguments are given, the default is to open the Zoo documentation. -``` -# open the Zoo docs in your browser -$ zoo open docs - -# open your Zoo account in your browser -$ zoo open account -``` \ No newline at end of file + # open the Zoo docs in your browser + $ zoo open docs + + # open your Zoo account in your browser + $ zoo open account + \ No newline at end of file diff --git a/content/pages/docs/cli/manual/zoo_say.md b/content/pages/docs/cli/manual/zoo_say.md index 2c2ab019..fd811559 100644 --- a/content/pages/docs/cli/manual/zoo_say.md +++ b/content/pages/docs/cli/manual/zoo_say.md @@ -25,8 +25,8 @@ Prints your text in a text bubble with Zoo as ASCII art ### About -``` -$ zoo say -$ zoo say hello! -$ zoo say Hello World! -``` \ No newline at end of file + + $ zoo say + $ zoo say hello! + $ zoo say Hello World! + \ No newline at end of file