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
1 change: 1 addition & 0 deletions content/pages/docs/cli/manual/zoo.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Work seamlessly with Zoo from the command line
* [zoo generate](./zoo_generate)
* [zoo kcl](./zoo_kcl)
* [zoo ml](./zoo_ml)
* [zoo project](./zoo_project)
* [zoo say](./zoo_say)
* [zoo start-session](./zoo_start-session)
* [zoo open](./zoo_open)
Expand Down
31 changes: 31 additions & 0 deletions content/pages/docs/cli/manual/zoo_project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "zoo project"
excerpt: "Manage Zoo projects."
layout: manual
---

Manage Zoo projects.

### Subcommands

* [zoo project categories](./zoo_project_categories)
* [zoo project delete](./zoo_project_delete)
* [zoo project download](./zoo_project_download)
* [zoo project list](./zoo_project_list)
* [zoo project publish](./zoo_project_publish)
* [zoo project view](./zoo_project_view)
* [zoo project upload](./zoo_project_upload)

### Options

<dl class="flags">
<dt><code>-d/--debug</code></dt>
<dd>Print debug info<br/>Default value: <code>false</code></dd>

<dt><code>--host</code></dt>
<dd>Zoo API host to use for all commands (e.g., "api.zoo.dev" or "http://localhost:8888"). Overrides the configured default host</dd>

<dt><code>-h/--help</code></dt>
<dd>Print help</dd>
</dl>

28 changes: 28 additions & 0 deletions content/pages/docs/cli/manual/zoo_project_categories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "zoo project categories"
excerpt: "List the active project categories available for submission."
layout: manual
---

List the active project categories available for submission.

### Options

<dl class="flags">
<dt><code>-f/--format</code></dt>
<dd>Command output format<br/>Possible values: <code>json | yaml | table</code></dd>

<dt><code>-d/--debug</code></dt>
<dd>Print debug info<br/>Default value: <code>false</code></dd>

<dt><code>--host</code></dt>
<dd>Zoo API host to use for all commands (e.g., "api.zoo.dev" or "http://localhost:8888"). Overrides the configured default host</dd>

<dt><code>-h/--help</code></dt>
<dd>Print help</dd>
</dl>


### See also

* [zoo project](./zoo_project)
30 changes: 30 additions & 0 deletions content/pages/docs/cli/manual/zoo_project_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "zoo project delete"
excerpt: "Delete one of your uploaded projects."
layout: manual
---

Delete one of your uploaded projects.

### Options

<dl class="flags">
<dt><code>id-or-path</code></dt>
<dd>The project id, or a local project directory, `.kcl` file, or `project.toml`.

When a local path is provided, the persisted Zoo cloud project id will be removed from `project.toml` after the remote project is deleted.</dd>

<dt><code>-d/--debug</code></dt>
<dd>Print debug info<br/>Default value: <code>false</code></dd>

<dt><code>--host</code></dt>
<dd>Zoo API host to use for all commands (e.g., "api.zoo.dev" or "http://localhost:8888"). Overrides the configured default host</dd>

<dt><code>-h/--help</code></dt>
<dd>Print help (see a summary with '-h')</dd>
</dl>


### See also

* [zoo project](./zoo_project)
34 changes: 34 additions & 0 deletions content/pages/docs/cli/manual/zoo_project_download.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: "zoo project download"
excerpt: "Download one of your projects into a local directory."
layout: manual
---

Download one of your projects into a local directory.

### Options

<dl class="flags">
<dt><code>id</code></dt>
<dd>The project id</dd>

<dt><code>output-dir</code></dt>
<dd>The directory to extract the project into<br/>Default value: <code>.</code></dd>

<dt><code>--force</code></dt>
<dd>Allow extracting into a non-empty destination, overwriting existing files in place<br/>Default value: <code>false</code></dd>

<dt><code>-d/--debug</code></dt>
<dd>Print debug info<br/>Default value: <code>false</code></dd>

<dt><code>--host</code></dt>
<dd>Zoo API host to use for all commands (e.g., "api.zoo.dev" or "http://localhost:8888"). Overrides the configured default host</dd>

<dt><code>-h/--help</code></dt>
<dd>Print help</dd>
</dl>


### See also

* [zoo project](./zoo_project)
28 changes: 28 additions & 0 deletions content/pages/docs/cli/manual/zoo_project_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "zoo project list"
excerpt: "List your projects."
layout: manual
---

List your projects.

### Options

<dl class="flags">
<dt><code>-f/--format</code></dt>
<dd>Command output format<br/>Possible values: <code>json | yaml | table</code></dd>

<dt><code>-d/--debug</code></dt>
<dd>Print debug info<br/>Default value: <code>false</code></dd>

<dt><code>--host</code></dt>
<dd>Zoo API host to use for all commands (e.g., "api.zoo.dev" or "http://localhost:8888"). Overrides the configured default host</dd>

<dt><code>-h/--help</code></dt>
<dd>Print help</dd>
</dl>


### See also

* [zoo project](./zoo_project)
31 changes: 31 additions & 0 deletions content/pages/docs/cli/manual/zoo_project_publish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "zoo project publish"
excerpt: "Submit an existing cloud project for publication review."
layout: manual
---

Submit an existing cloud project for publication review.

### Options

<dl class="flags">
<dt><code>id-or-path</code></dt>
<dd>The project id, or a local project directory, `.kcl` file, or `project.toml`</dd>

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

<dt><code>-d/--debug</code></dt>
<dd>Print debug info<br/>Default value: <code>false</code></dd>

<dt><code>--host</code></dt>
<dd>Zoo API host to use for all commands (e.g., "api.zoo.dev" or "http://localhost:8888"). Overrides the configured default host</dd>

<dt><code>-h/--help</code></dt>
<dd>Print help</dd>
</dl>


### See also

* [zoo project](./zoo_project)
48 changes: 48 additions & 0 deletions content/pages/docs/cli/manual/zoo_project_upload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: "zoo project upload"
excerpt: "Upload a local project."
layout: manual
---

Upload a local project.

### Options

<dl class="flags">
<dt><code>input</code></dt>
<dd>The project directory, a `.kcl` file within it, or `project.toml`<br/>Default value: <code>.</code></dd>

<dt><code>--new</code></dt>
<dd>Always create a new remote project even if one is already persisted locally<br/>Default value: <code>false</code></dd>

<dt><code>--id</code></dt>
<dd>Override the persisted Zoo cloud project id from `project.toml`</dd>

<dt><code>--title</code></dt>
<dd>Title to use for the cloud project. Defaults to the local project directory name</dd>

<dt><code>--description</code></dt>
<dd>Description to use for the cloud project. Defaults to the existing remote description when updating</dd>

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

<dt><code>-d/--debug</code></dt>
<dd>Print debug info<br/>Default value: <code>false</code></dd>

<dt><code>--host</code></dt>
<dd>Zoo API host to use for all commands (e.g., "api.zoo.dev" or "http://localhost:8888"). Overrides the configured default host</dd>

<dt><code>-h/--help</code></dt>
<dd>Print help (see a summary with '-h')</dd>
</dl>


### About

If the local `project.toml` already contains a Zoo cloud project id, this
will update that project unless `--new` is passed.

### See also

* [zoo project](./zoo_project)
31 changes: 31 additions & 0 deletions content/pages/docs/cli/manual/zoo_project_view.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "zoo project view"
excerpt: "View one of your projects."
layout: manual
---

View one of your projects.

### Options

<dl class="flags">
<dt><code>id-or-path</code></dt>
<dd>The project id, or a local project directory, `.kcl` file, or `project.toml`</dd>

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

<dt><code>-d/--debug</code></dt>
<dd>Print debug info<br/>Default value: <code>false</code></dd>

<dt><code>--host</code></dt>
<dd>Zoo API host to use for all commands (e.g., "api.zoo.dev" or "http://localhost:8888"). Overrides the configured default host</dd>

<dt><code>-h/--help</code></dt>
<dd>Print help</dd>
</dl>


### See also

* [zoo project](./zoo_project)
3 changes: 3 additions & 0 deletions content/pages/docs/cli/manual/zoo_user_edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ Edit user settings.
<dt><code>-p/--phone</code></dt>
<dd>The user's phone number<br/>Default value: <code></code></dd>

<dt><code>-u/--username</code></dt>
<dd>Public username/handle for community-facing features. Empty clears it</dd>

<dt><code>-d/--debug</code></dt>
<dd>Print debug info<br/>Default value: <code>false</code></dd>

Expand Down
Loading