Quix-61014: yaml reference (#62)

.github/workflows/release-docs.yml

@@ -23,7 +23,7 @@ jobs:
       run: curl -fsSL https://github.com/quixio/quix-cli/raw/main/install.sh | bash
 
     - name: Run Quix CLI to generate docs
-      run: quix docs ${{ github.workspace }}/docs/Reference
+      run: quix docs "${{ github.workspace }}/docs/CLI Reference"
 
     - name: Create Pull Request
       uses: peter-evans/create-pull-request@v5

docs/cli-commands-summary.md

@@ -6,68 +6,68 @@ This quick reference guide lists common use cases for the Quix CLI with the corr
 
 | Use Case                                                                           | Command                |
 | ---------------------------------------------------------------------------------- | ---------------------- |
-| [Update application `.env` files from `quix.yaml`](./Reference/init.md)            | `quix init --update`   |
-| [Run applications with the variables from `.env`](./Reference/run.md)              | `quix run`             |
-| [Update pipeline configuration](./Reference/pipeline/update.md)                    | `quix pipeline update` |
-| [Bring pipeline up in Docker](./Reference/pipeline/up.md)                          | `quix pipeline up`     |
-| [Get a global status check of the CLI settings](./Reference/status.md)             | `quix status`          |
-| [Display the current status of the local pipeline](./Reference/pipeline/status.md) | `quix pipeline status` |
-| [Push local changes to Git and sync with Quix Cloud](./Reference/pipeline/sync.md) | `quix pipeline sync`   |
+| [Update application `.env` files from `quix.yaml`](./cli-reference/init.md)            | `quix init --update`   |
+| [Run applications with the variables from `.env`](./cli-reference/run.md)              | `quix run`             |
+| [Update pipeline configuration](./cli-reference/pipeline/update.md)                    | `quix pipeline update` |
+| [Bring pipeline up in Docker](./cli-reference/pipeline/up.md)                          | `quix pipeline up`     |
+| [Get a global status check of the CLI settings](./cli-reference/status.md)             | `quix status`          |
+| [Display the current status of the local pipeline](./cli-reference/pipeline/status.md) | `quix pipeline status` |
+| [Push local changes to Git and sync with Quix Cloud](./cli-reference/pipeline/sync.md) | `quix pipeline sync`   |
 
 ## Initialization
 
 | Use Case                                                                           | Command                    |
 | ---------------------------------------------------------------------------------- | -------------------------- |
-| [Initialize a new Quix project](./Reference/init.md)                               | `quix init`                |
-| [Initialize with DevContainer support](./Reference/init.md)                        | `quix init --devcontainer` |
-| [Initialize a project updating `.env` files from `quix.yaml`](./Reference/init.md) | `quix init --update`       |
+| [Initialize a new Quix project](./cli-reference/init.md)                               | `quix init`                |
+| [Initialize with DevContainer support](./cli-reference/init.md)                        | `quix init --devcontainer` |
+| [Initialize a project updating `.env` files from `quix.yaml`](./cli-reference/init.md) | `quix init --update`       |
 
 ## Application Management
 
 | Use Case                                                                   | Command              |
 | -------------------------------------------------------------------------- | -------------------- |
-| [Create a new application](./Reference/apps/create.md)                     | `quix app add`       |
-| [Edit the variables of an application](./Reference/apps/edit.md)           | `quix app edit`      |
-| [List applications in the project](./Reference/apps/list.md)               | `quix app list`      |
-| [Add a variable to an application](./Reference/apps/variables/create.md)   | `quix app vars add`  |
-| [Edit the variables of an application](./Reference/apps/variables/edit.md) | `quix app vars edit` |
+| [Create a new application](./cli-reference/apps/create.md)                     | `quix app add`       |
+| [Edit the variables of an application](./cli-reference/apps/edit.md)           | `quix app edit`      |
+| [List applications in the project](./cli-reference/apps/list.md)               | `quix app list`      |
+| [Add a variable to an application](./cli-reference/apps/variables/create.md)   | `quix app vars add`  |
+| [Edit the variables of an application](./cli-reference/apps/variables/edit.md) | `quix app vars edit` |
 
 ## Pipeline Management
 
 | Use Case                                                                                   | Command                     |
 | ------------------------------------------------------------------------------------------ | --------------------------- |
-| [Update pipeline from current applications configurations](./Reference/pipeline/update.md) | `quix pipeline update`      |
-| [View pipeline graph](./Reference/pipeline/view.md)                                        | `quix pipeline view`        |
-| [Bring pipeline up in Docker](./Reference/pipeline/up.md)                                  | `quix pipeline up`          |
-| [Bring pipeline up in Docker and update the configuration](./Reference/pipeline/up.md)     | `quix pipeline up --update` |
-| [Bring pipeline down in Docker](./Reference/pipeline/down.md)                              | `quix pipeline down`        |
-| [Start a deployment in Docker](./Reference/pipeline/start.md)                              | `quix pipeline start`       |
-| [Stop a deployment in Docker](./Reference/pipeline/stop.md)                                | `quix pipeline stop`        |
-| [Read the logs from the local pipeline](./Reference/pipeline/logs.md)                      | `quix pipeline logs`        |
-| [Push local changes to Git and sync with Quix Cloud](./Reference/pipeline/sync.md)         | `quix pipeline sync`        |
+| [Update pipeline from current applications configurations](./cli-reference/pipeline/update.md) | `quix pipeline update`      |
+| [View pipeline graph](./cli-reference/pipeline/view.md)                                        | `quix pipeline view`        |
+| [Bring pipeline up in Docker](./cli-reference/pipeline/up.md)                                  | `quix pipeline up`          |
+| [Bring pipeline up in Docker and update the configuration](./cli-reference/pipeline/up.md)     | `quix pipeline up --update` |
+| [Bring pipeline down in Docker](./cli-reference/pipeline/down.md)                              | `quix pipeline down`        |
+| [Start a deployment in Docker](./cli-reference/pipeline/start.md)                              | `quix pipeline start`       |
+| [Stop a deployment in Docker](./cli-reference/pipeline/stop.md)                                | `quix pipeline stop`        |
+| [Read the logs from the local pipeline](./cli-reference/pipeline/logs.md)                      | `quix pipeline logs`        |
+| [Push local changes to Git and sync with Quix Cloud](./cli-reference/pipeline/sync.md)         | `quix pipeline sync`        |
 
 ## Broker Management
 
 | Use Case                                                                                   | Command                  |
 | ------------------------------------------------------------------------------------------ | ------------------------ |
-| [Start local pipeline broker](./Reference/broker/up.md)                                    | `quix broker up`         |
-| [Stop local pipeline broker](./Reference/broker/down.md)                                   | `quix broker down`       |
-| [List all the topics from your pipeline broker](./Reference/broker/topics/list.md)         | `quix broker topic list` |
-| [Read the content of a topic from your pipeline broker](./Reference/broker/topics/read.md) | `quix broker topic read` |
+| [Start local pipeline broker](./cli-reference/broker/up.md)                                    | `quix broker up`         |
+| [Stop local pipeline broker](./cli-reference/broker/down.md)                                   | `quix broker down`       |
+| [List all the topics from your pipeline broker](./cli-reference/broker/topics/list.md)         | `quix broker topic list` |
+| [Read the content of a topic from your pipeline broker](./cli-reference/broker/topics/read.md) | `quix broker topic read` |
 
 ## SDK Broker Configuration
 
 | Use Case                                                                         | Command                                         |
 | -------------------------------------------------------------------------------- | ----------------------------------------------- |
-| [Set SDK broker to custom local address](./Reference/sdk/broker/set.md)          | `quix sdk broker set <broker-address> --enable` |
-| [Set SDK broker to Quix Cloud](./Reference/sdk/broker/cloud.md)                  | `quix sdk broker cloud`                         |
-| [Set SDK broker to default local configuration](./Reference/sdk/broker/local.md) | `quix sdk broker local`                         |
+| [Set SDK broker to custom local address](./cli-reference/sdk/broker/set.md)          | `quix sdk broker set <broker-address> --enable` |
+| [Set SDK broker to Quix Cloud](./cli-reference/sdk/broker/cloud.md)                  | `quix sdk broker cloud`                         |
+| [Set SDK broker to default local configuration](./cli-reference/sdk/broker/local.md) | `quix sdk broker local`                         |
 
 ## Running Applications
 
 | Use Case                                                                    | Command                |
 | --------------------------------------------------------------------------- | ---------------------- |
-| [Run with the variables from `.env`](./Reference/run.md)                    | `quix run`             |
-| [Update the `.env` variables from the pipeline and run](./Reference/run.md) | `quix run --update`    |
-| [Run and stop deployed version of the application](./Reference/run.md)      | `quix run --stop`      |
-| [Run and intercept deployed version of the application](./Reference/run.md) | `quix run --intercept` |
+| [Run with the variables from `.env`](./cli-reference/run.md)                    | `quix run`             |
+| [Update the `.env` variables from the pipeline and run](./cli-reference/run.md) | `quix run --update`    |
+| [Run and stop deployed version of the application](./cli-reference/run.md)      | `quix run --stop`      |
+| [Run and intercept deployed version of the application](./cli-reference/run.md) | `quix run --intercept` |

docs/cli-local-debug.md

@@ -81,7 +81,7 @@ Depending on your setup, you can choose to use your local pipeline broker, anoth
         quix sdk broker local
         ```
 
-    For more details on the `set` command, refer to the [set broker documentation](./Reference/sdk/broker/set.md).
+    For more details on the `set` command, refer to the [set broker documentation](./cli-reference/sdk/broker/set.md).
 
     !!! warning
         This doesn't change your local pipeline broker, just the broker you use when you run the application locally outside the pipeline.
@@ -96,14 +96,14 @@ Depending on your setup, you can choose to use your local pipeline broker, anoth
 
     This configuration is ideal if you want to test your application in an environment that closely resembles production.
 
-    For more details on the `cloud` command, refer to the [cloud broker documentation](./Reference/sdk/broker/cloud.md).
+    For more details on the `cloud` command, refer to the [cloud broker documentation](./cli-reference/sdk/broker/cloud.md).
 
     !!! warning
         This doesn't change your local pipeline broker, just the broker you use when you run the application locally outside the pipeline.
 
 ---
 
-For a comprehensive overview of all SDK broker commands, refer to the [SDK broker documentation](./Reference/sdk/broker/index.md).
+For a comprehensive overview of all SDK broker commands, refer to the [SDK broker documentation](./cli-reference/sdk/broker/index.md).
 
 ### Step 2: Preparing Your Local Environment
 
@@ -232,7 +232,7 @@ You can create and remove variables for your local applications here at your dis
 
 ### Step 4: Running Your Code with `quix run`
 
-By using the [`quix run`](./Reference/run.md) command, the `.env` variables are injected into your Python code as environment variables so you can read the values like this:
+By using the [`quix run`](./cli-reference/run.md) command, the `.env` variables are injected into your Python code as environment variables so you can read the values like this:
 
 ```python title="main.py"
 import os
@@ -401,12 +401,12 @@ variable=a-pipeline-value
 
 There are several other CLI commands that you may find very useful during your local development. Here are some of the most relevant ones:
 
-- [quix pipeline view](./Reference/pipeline/view.md): Create and preview a mermaid diagram of the pipeline.
-- [quix pipeline up](./Reference/pipeline/up.md): Run your pipeline locally using docker compose
-- [quix pipeline status](./Reference/pipeline/status.md): Display the current status of the local pipeline
-- [quix pipeline logs -f -n 10](./Reference/pipeline/logs.md): View output from deployments of the local pipeline in realtime
-- [quix pipeline sync](./Reference/pipeline/sync.md): Synchronize your local pipeline to Quix Cloud
-- [quix broker topics read](./Reference/broker/topics/read.md): Read the messages from your pipeline topics
+- [quix pipeline view](./cli-reference/pipeline/view.md): Create and preview a mermaid diagram of the pipeline.
+- [quix pipeline up](./cli-reference//pipeline/up.md): Run your pipeline locally using docker compose
+- [quix pipeline status](./cli-reference/pipeline/status.md): Display the current status of the local pipeline
+- [quix pipeline logs -f -n 10](./cli-reference/pipeline/logs.md): View output from deployments of the local pipeline in realtime
+- [quix pipeline sync](./cli-reference/pipeline/sync.md): Synchronize your local pipeline to Quix Cloud
+- [quix broker topics read](./cli-reference/broker/topics/read.md): Read the messages from your pipeline topics
 
 You should also check our [CLI Commands Summary](./cli-commands-summary.md), where you'll find the most useful commands for developing QuixStreams data pipelines locally.
 

docs/Reference/apps/create.gen.md → docs/cli-reference/apps/create.gen.md

@@ -9,12 +9,12 @@ Creates a new application locally based on a code sample of the library
 **Usage:**
 
 ```
-quix apps create [<library-item>] [options]
+quix apps create [<library-item-id>] [options]
 ```
 
 **Arguments:**
 
-- `<library-item>` : If omitted, an interactive list is displayed. Use this argument to manually specify the library item you want to use. Use `quix cloud applications library list` to see all available items.
+- `<library-item-id>` : If omitted, an interactive list is displayed. Use this argument to manually specify the library item you want to use. Use 'quix app library' to see all available items.
 
 **Options:**
 

docs/cli-reference/apps/delete.gen.md

@@ -0,0 +1,18 @@
+# apps delete
+
+## Overview
+
+Remove an application
+
+**Aliases:** `delete`, `del`, `remove`, `rm`
+
+**Usage:**
+
+```
+quix apps delete [options]
+```
+
+**Options:**
+
+- `-d, --directory <directory>` : Base directory (defaults to current directory)
+

docs/Reference/apps/index.gen.md → docs/cli-reference/apps/index.gen.md

@@ -16,7 +16,9 @@ quix apps [command] [options]
 
 - [convert](convert.md) : Converts applications from and to library item format
 - [create](create.md) : Creates a new application locally based on a code sample of the library
+- [delete](delete.md) : Remove an application
 - [edit](edit.md) : Edit the application values
+- [library](library.md) : Retrieve all library items
 - [list](list.md) : Lists all the local applications of the project
 - [update](update.md) : Updates the application's '.env' file with the variables from 'quix.yaml'
 - [variables](variables/index.md) : Manage your local application's variables

docs/cli-reference/apps/library.gen.md

@@ -0,0 +1,21 @@
+# apps library
+
+## Overview
+
+Retrieve all library items
+
+**Aliases:** `library`, `lib`
+
+**Usage:**
+
+```
+quix apps library [options]
+```
+
+**Options:**
+
+- `-o, --output <json|table>` : Output type of the retrieved data
+- `--language <language>` : Filter items by language
+- `--tags <tags>` : Filter items by tag(s)
+- `-s, --search <search>` : Search for this string within the library item fields
+

docs/cli-reference/apps/library.md

@@ -0,0 +1 @@
+{% include-markdown './library.gen.md' %}

docs/Reference/broker/topics/index.gen.md → docs/cli-reference/broker/topics/index.gen.md

@@ -17,4 +17,5 @@ quix broker topics [command] [options]
 - [list](list.md) : List your pipeline broker topics
 - [read](read.md) : Read the messages from your pipeline topics
 - [update](update.md) : Update or create your pipeline broker topics from your 'quix.yaml' configuration
+- [write](write.md) : Write messages from the standard input to your pipeline topics
 

docs/cli-reference/broker/topics/write.gen.md

@@ -0,0 +1,27 @@
+# broker topics write
+
+## Overview
+
+Write messages from the standard input to your pipeline topics
+
+**Aliases:** `write`
+
+**Usage:**
+
+```
+quix broker topics write [<topic>] [options]
+```
+
+**Arguments:**
+
+- `<topic>` : The topic to send data to
+
+**Options:**
+
+- `--directory <directory>` : If specified, it will use that directory instead of the current one
+- `-k, --key <key>` : Specify a key for each message, allowing messages to be partitioned and ordered by key
+- `-f, --file <file>` : Read messages from the specified file, sending each line as an individual message
+- `-s, --batch-size <batch-size>` : Number of messages to include in each batch sent to the topic [default: 1]
+- `-d, --batch-delay <batch-delay>` : Delay in milliseconds between sending each batch, useful for rate limiting [default: 0]
+- `-b, --broker-address <broker-address>` : The broker address to connect to [default: localhost:19092]
+

docs/cli-reference/broker/topics/write.md

@@ -0,0 +1 @@
+{% include-markdown './write.gen.md' %}

docs/Reference/cloud/apps/library/list.gen.md → docs/cli-reference/cloud/apps/library/list.gen.md

@@ -17,4 +17,5 @@ quix cloud apps library list [options]
 - `-o, --output <json|table>` : Output type of the retrieved data
 - `--language <language>` : Filter items by language
 - `--tags <tags>` : Filter items by tag(s)
+- `-s, --search <search>` : Search for this string within the library item fields
 

docs/Reference/cloud/users/permissions/edit.gen.md → docs/cli-reference/cloud/users/permissions/edit.gen.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-Adds or edits the value of a single permission of a user in the organisation. Available roles: [Admin, Manager, Editor, Viewer]
+Adds or edits the value of a single permission of a user in the organisation. Available roles: [Admin, Manager, Editor, Viewer, None]
 
 **Aliases:** `edit`
 

docs/Reference/cloud/users/permissions/index.gen.md → docs/cli-reference/cloud/users/permissions/index.gen.md

@@ -16,8 +16,8 @@ quix cloud users permissions [command] [options]
 
 - [copy](copy.md) : Copy the user permissions from a user to other users
 - [delete](delete.md) : Deletes the value of a single permission of a user in the organisation
-- [edit](edit.md) : Adds or edits the value of a single permission of a user in the organisation. Available roles: [Admin, Manager, Editor, Viewer]
+- [edit](edit.md) : Adds or edits the value of a single permission of a user in the organisation. Available roles: [Admin, Manager, Editor, Viewer, None]
 - [get](get.md) : Get the permissions of a user or all the users in the organisation
 - [list](list.md) : Get the permissions of all the users in the organisation
-- [set](set.md) : Sets the whole permissions of a user, replacing the current ones. Available roles: [Admin, Manager, Editor, Viewer]
+- [set](set.md) : Sets the whole permissions of a user, replacing the current ones. Available roles: [Admin, Manager, Editor, Viewer, None]
 

docs/Reference/cloud/users/permissions/set.gen.md → docs/cli-reference/cloud/users/permissions/set.gen.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-Sets the whole permissions of a user, replacing the current ones. Available roles: [Admin, Manager, Editor, Viewer]
+Sets the whole permissions of a user, replacing the current ones. Available roles: [Admin, Manager, Editor, Viewer, None]
 
 **Aliases:** `set`