Skip to content
Open
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
8 changes: 4 additions & 4 deletions content/pages/docs/cli/manual/zoo_api-call.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

# convert a step file to an obj file
$ zoo file convert ./input.step ./output.obj
8 changes: 4 additions & 4 deletions content/pages/docs/cli/manual/zoo_api-call_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Perform operations for API calls.

### About

```
# get the status of an async API call
$ zoo api-call status <id>
```

# get the status of an async API call
$ zoo api-call status <id>

### See also

Expand Down
13 changes: 6 additions & 7 deletions content/pages/docs/cli/manual/zoo_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
$ zoo app .

$ zoo app main.kcl

$ zoo app ../main.kcl

25 changes: 12 additions & 13 deletions content/pages/docs/cli/manual/zoo_auth_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
13 changes: 6 additions & 7 deletions content/pages/docs/cli/manual/zoo_auth_logout.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
34 changes: 14 additions & 20 deletions content/pages/docs/cli/manual/zoo_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,46 +39,40 @@ 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.

### fish

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)
```
Invoke-Expression -Command $(zoo completion -s powershell | Out-String)

6 changes: 3 additions & 3 deletions content/pages/docs/cli/manual/zoo_drake.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ Open a drake meme in your web browser.

### About

```
$ zoo drake
```

$ zoo drake
8 changes: 4 additions & 4 deletions content/pages/docs/cli/manual/zoo_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ./
```

# convert a step file to an obj file
$ zoo file convert --output-format=obj ./input.step ./
13 changes: 6 additions & 7 deletions content/pages/docs/cli/manual/zoo_file_center-of-mass.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <id_of_your_operation>` 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

Expand Down
21 changes: 10 additions & 11 deletions content/pages/docs/cli/manual/zoo_file_convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <id_of_your_operation>` 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

Expand Down
13 changes: 6 additions & 7 deletions content/pages/docs/cli/manual/zoo_file_density.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <id_of_your_operation>` 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

Expand Down
13 changes: 6 additions & 7 deletions content/pages/docs/cli/manual/zoo_file_mass.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <id_of_your_operation>` 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

Expand Down
12 changes: 6 additions & 6 deletions content/pages/docs/cli/manual/zoo_file_snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
13 changes: 6 additions & 7 deletions content/pages/docs/cli/manual/zoo_file_surface-area.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <id_of_your_operation>` 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

Expand Down
13 changes: 6 additions & 7 deletions content/pages/docs/cli/manual/zoo_file_volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <id_of_your_operation>` 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

Expand Down
1 change: 1 addition & 0 deletions content/pages/docs/cli/manual/zoo_kcl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
13 changes: 6 additions & 7 deletions content/pages/docs/cli/manual/zoo_kcl_analyze.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading
Loading