UffizziCloud · gadkins · Aug 16, 2022 · Aug 16, 2022 · Aug 16, 2022 · Aug 16, 2022
diff --git a/docs/guides/git-integrations.md b/docs/guides/git-integrations.md
diff --git a/docs/references/cli/config.md b/docs/references/cli/config.md
@@ -0,0 +1 @@
+# `uffizzi config`
diff --git a/docs/references/cli/connect.md b/docs/references/cli/connect.md
@@ -0,0 +1 @@
+# `uffizzi connect`
diff --git a/docs/references/cli/help.md b/docs/references/cli/help.md
@@ -0,0 +1 @@
+# `uffizzi help`
diff --git a/docs/references/cli/login.md b/docs/references/cli/login.md
@@ -0,0 +1 @@
+# `uffizzi login`
diff --git a/docs/references/cli/logout.md b/docs/references/cli/logout.md
@@ -0,0 +1 @@
+# `uffizzi logout`
diff --git a/docs/references/cli/preview.md b/docs/references/cli/preview.md
@@ -0,0 +1,152 @@
+# `uffizzi preview`  
+
+## Usage  
+
+```
+$ uffizzi preview COMMAND
+```
+
+## Description
+
+Manage Uffizzi previews
+
+## Child commands
+
+| **Command**                                     | **Description**              |
+|-------------------------------------------------|------------------------------|
+| [uffizzi preview create](preview.md#create)     | Create a preview             |
+| [uffizzi preview delete](preview.md#delete)     | Delete a preview             |
+| [uffizzi preview describe](preview.md#describe) | Display details of a preview |
+| [uffizzi preview list](preview.md#list)         | list all previews            | 
+
+
+## <a id="create"></a> `uffizzi preview create`  
+
+### Usage
+
+```  
+$ uffizzi preview create [POSITIONAL_ARGUMENTS] [UFFIZZI_WIDE_FLAG ...]
+```
+
+### Description
+
+Creates a new preview. If no `COMPOSE_FILE` is specified, the preview is created with the project´s default compose file. This command can fail for the following reasons:  
+
+- The project does not have a default compose file set. Run `$ uffizzi compose --help` for details.  
+- The alternate compose file is invalid.  
+
+### Positional arguments
+
+`[COMPOSE_FILE]` - An alternate compose file to the default compose.
+
+You can pass a compose file to this command to create an ad hoc preview of an alternate compose configuration. The file passed via this argument does not replace the default compose file for the project. Alternate compose files share the same lifecyle as the previews they create: when the preview is deleted, the alternate compose is deleted by the Uffizzi API.
+
+### Uffizzi wide flags
+
+The flag `--project` is available to all commands. Run `$ uffizzi help` for details.
+
+### Examples  
+
+To create a preview with the project´s default compose file, run:  
+
+```
+$ uffizzi preview create
+```
+
+To create a preview with an alternate compose file, run:  
+
+```
+$ uffizzi preview create docker-compose.uffizzi.alt.yml
+```
+
+## <a id="delete"></a> `uffizzi preview delete`  
+
+### Usage
+
+```  
+$ uffizzi preview delete [POSITIONAL_ARGUMENTS] [UFFIZZI_WIDE_FLAG ...]
+```
+
+### Description
+
+Deletes a preview with the given preview ID. This command can fail for the following reasons:  
+
+- The preview specified does not exist.
+- The preview specified belongs to a different project.
+
+### Positional arguments
+
+`[PREVIEW_ID]` - ID for the preview you want to delete.  
+
+### Uffizzi wide flags
+
+The flag `--project` is available to all commands. Run `$ uffizzi help` for details.
+
+### Examples  
+
+The following command deletes the preview with ID `deployment-213`:
+
+```
+$ uffizzi preview delete deployment-213
+```
+
+## <a id="describe"></a> `uffizzi preview describe`  
+
+### Usage
+
+```  
+$ uffizzi preview describe [POSITIONAL_ARGUMENTS] [UFFIZZI_WIDE_FLAG ...]
+```
+
+### Description
+
+Shows metadata for a project given a valid preview ID. This command can fail for the following reasons:  
+
+- The preview specified does not exist.
+- The preview specified belongs to a different project.  
+
+### Positional arguments
+
+`[PREVIEW_ID]` - ID for the preview you want to describe.  
+
+### Uffizzi wide flags
+
+The flag `--project` is available to all commands. Run `$ uffizzi help` for details.
+
+### Examples  
+
+The following command prints metadata for the preview with ID
+`deployment-213`:
+
+```
+$ uffizzi preview describe deployment-213
+```
+
+## <a id="list"></a> `uffizzi preview list`  
+
+### Usage
+
+```
+$ uffizzi preview list [UFFIZZI_WIDE_FLAG ...]
+```
+
+### Description
+
+Lists all previews for a project, including `active`, `building`, `deploying` and `failed` previews.  
+
+### Uffizzi wide flags
+The flag `--project` is available to all commands. Run `$ uffizzi help` for details.
+
+### Examples  
+
+To list all previews in the default project, run:
+
+```
+$ uffizzi preview list
+```
+
+To list all previews in a project with name `my_project`, run:
+
+```
+$ uffizzi preview list --project="my_project"
+```
diff --git a/docs/references/cli/project.md b/docs/references/cli/project.md
@@ -0,0 +1 @@
+# `uffizzi project`
diff --git a/docs/references/cli/uffizzi.md b/docs/references/cli/uffizzi.md
@@ -0,0 +1,18 @@
+# Uffizzi command-line reference
+
+## `uffizzi`
+
+The base command for the Uffizzi CLI.
+
+### Child commands  
+
+| **Command**                             | **Description**                                              |
+|-----------------------------------------|--------------------------------------------------------------|
+| [uffizzi config](config.md)     | Configure the Uffizzi CLI                                    |
+| [uffizzi connect](connect.md)   | Grant a Uffizzi user account access to external services     |
+| [uffizzi help](help.md)         | Show Uffizzi documentation                                    |
+| [uffizzi login](login.md)       | Log in to a Uffizzi user account                             |
+| [uffizzi logout](logout.md)     | Log out of a Uffizzi user account                            |
+| [uffizzi preview](preview.md)   | Manage Uffizzi previews and view logs                        |
+| [uffizzi project](project.md)   | Manage Uffizzi project resources                             |
+| [uffizzi version](version.md)   | Print version information for Uffizzi CLI                    |
diff --git a/docs/references/cli/version.md b/docs/references/cli/version.md
@@ -0,0 +1 @@
+# `uffizzi version`
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -25,7 +25,6 @@ theme:
     - content.code.annotate
     - navigation.instant
     - navigation.tracking
-    - navigation.tabs
     - navigation.sections
     - navigation.expand
     - navigation.indexes
@@ -106,16 +105,25 @@ nav:
     - UFFIZZI_URL: uffizzi-url.md
   - Guides: 
     - Configure password-protected environments: guides/password-protected.md
-    - Configure GitHub: guides/git-integrations.md
     - Connect to your container registry (Uffizzi CI): guides/container-registry-integrations.md
     - Add environment variables: guides/environment-variables.md
     - Add secrets: guides/secrets.md
     - Check logs: guides/logs.md
     - Configure role-based access: guides/rbac.md
     - Configure SSO: guides/single-sign-on.md 
     - Networking and architecture: guides/networking.md
-  - References:
-    - Uffizzi Compose file reference: references/compose-spec.md
+  - Docker Compose for Uffizzi: 
+    - Compose file reference: references/compose-spec.md
+  - Command-line reference:
+    - uffizzi (base command): references/cli/uffizzi.md
+    - uffizzi config: references/cli/config.md
+    - uffizzi connect: references/cli/connect.md
+    - uffizzi help: references/cli/help.md
+    - uffizzi login: references/cli/login.md
+    - uffizzi logout: references/cli/logout.md
+    - uffizzi preview: references/cli/preview.md
+    - uffizzi project: references/cli/project.md
+    - uffizzi version: references/cli/version.md
     - Uffizzi environment variables: references/uffizzi-environment-variables.md
     - Example Uffizzi Compose: references/example-compose.md
   - Use Cases: