Merge branch 'main' of github.com:quixio/quix-cli

docs/cli-github-actions.md → docs/How-To/cli-github-actions.md

@@ -21,7 +21,7 @@ The basic procedure to use the Quix CLI in a GitHub Action is:
 2. Authenticate the CLI with Quix Cloud using the command `quix login <pat>`, where `<pat>` is the [personal access token](../develop/authentication/personal-access-token.md) for the environment. 
 3. Run your CLI command or commands.
 
-In this case you'll run the command to synchronize the repository with Quix using the command `quix env sync <workspace-id>`. You can obtain the Workspace ID from your environment settings.
+In this case you'll run the command to synchronize the repository with Quix using the command `quix cloud env sync <workspace-id>`. You can obtain the Workspace ID from your environment settings.
 
 !!! tip
 
@@ -64,7 +64,7 @@ jobs:
           curl -fsSL https://github.com/quixio/quix-cli/raw/main/install.sh | bash
           echo Logging into Quix Cloud
           quix login ${{ secrets.QUIX_PAT }}
-          quix env sync ${{ secrets.WORKSPACE_ID }}
+          quix cloud env sync ${{ secrets.WORKSPACE_ID }}
 ```
 
 In this case the Action is run for `main` branch, but you could modify this or add other branches as required.

docs/Reference/applications/convert.gen.md → docs/Reference/apps/convert.gen.md

@@ -1,4 +1,4 @@
-# applications convert
+# apps convert
 
 ## Overview
 
@@ -9,7 +9,7 @@ Converts applications from and to library item format
 **Usage:**
 
 ```
-quix applications convert <file-path> [options]
+quix apps convert <file-path> [options]
 ```
 
 **Arguments:**

docs/Reference/applications/create.gen.md → docs/Reference/apps/create.gen.md

@@ -1,4 +1,4 @@
-# applications create
+# apps create
 
 ## Overview
 
@@ -9,7 +9,7 @@ Creates a new application locally based on a code sample of the library
 **Usage:**
 
 ```
-quix applications create [<library-item>] [options]
+quix apps create [<library-item>] [options]
 ```
 
 **Arguments:**

docs/Reference/applications/create.md → docs/Reference/apps/create.md

@@ -10,6 +10,7 @@ The command generates the application with a default structure relative to the c
 
 - The main Python file, usually `main.py`
 - `app.yaml` for application configuration
+- `.env` for environment variable management, allowing you to securely configure sensitive information like API keys and connection strings without hardcoding them into your scripts.
 - `requirements.txt` for Python dependencies
 - `dockerfile` for containerization
 - `README.md` for documentation
@@ -59,6 +60,24 @@ Leave the name empty so the default name is used:
 
 ```
 ✓ Application name: Starter Source
+```
+
+You can then select the values of the library item variables, such as topics. In this case, a list of existing topics is presented, where you can pick an existing topic or create a new one:
+
+```
+? [Output Topic] output:
+
+> csv-data
+  grouped-transactions
+  transactions-output
+  + New topic
+```
+
+After selecting the output topic:
+
+```
+✓ [Output Topic] output: csv-data
 ✓ Application 'Starter Source' created successfully in '$\Starter Source'
 ```
+
 Then your new `Starter Source` application is created.

docs/Reference/apps/edit.gen.md

@@ -0,0 +1,18 @@
+# apps edit
+
+## Overview
+
+Edit the application values
+
+**Aliases:** `edit`
+
+**Usage:**
+
+```
+quix apps edit [options]
+```
+
+**Options:**
+
+- `-d, --directory <directory>` : Base directory (defaults to current directory)
+

docs/Reference/apps/edit.md

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

docs/Reference/applications/index.gen.md → docs/Reference/apps/index.gen.md

@@ -1,21 +1,23 @@
-# applications
+# apps
 
 ## Overview
 
 Manage your local applications and their variables
 
-**Aliases:** `applications`, `application`, `apps`, `app`
+**Aliases:** `apps`, `applications`, `application`, `app`
 
 **Usage:**
 
 ```
-quix applications [command] [options]
+quix apps [command] [options]
 ```
 
 **Commands:**
 
 - [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
+- [edit](edit.md) : Edit the application values
 - [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/Reference/applications/list.gen.md → docs/Reference/apps/list.gen.md

@@ -1,4 +1,4 @@
-# applications list
+# apps list
 
 ## Overview
 
@@ -9,7 +9,7 @@ Lists all the local applications of the project
 **Usage:**
 
 ```
-quix applications list [options]
+quix apps list [options]
 ```
 
 **Options:**

docs/Reference/apps/update.gen.md

@@ -0,0 +1,23 @@
+# apps update
+
+## Overview
+
+Updates the application's '.env' file with the variables from 'quix.yaml'
+
+**Aliases:** `update`, `upd`
+
+**Usage:**
+
+```
+quix apps update [options]
+```
+
+**Options:**
+
+- `-a, --all` : Forces the update of all applications regardless of the current directory
+- `--workspace-id <workspace-id>` : The environment to use if your SDK broker configuration is set to Quix Cloud
+- `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
+- `--directory <directory>` : Base directory (defaults to current directory)
+- `--reset` : Removes all the values of existing env variables and adds them from the 'quix.yaml' file [default: False]
+- `--only-new` : Add only the missing variables in the '.env' file [default: False]
+

docs/Reference/apps/update.md

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

docs/Reference/applications/variables/create.gen.md → docs/Reference/apps/variables/create.gen.md

@@ -1,4 +1,4 @@
-# applications variables create
+# apps variables create
 
 ## Overview
 
@@ -9,7 +9,7 @@ Creates a variable of the current application
 **Usage:**
 
 ```
-quix applications variables create [options]
+quix apps variables create [options]
 ```
 
 **Options:**

docs/Reference/applications/variables/delete.gen.md → docs/Reference/apps/variables/delete.gen.md

@@ -1,4 +1,4 @@
-# applications variables delete
+# apps variables delete
 
 ## Overview
 
@@ -9,7 +9,7 @@ Deletes a variable of the current application
 **Usage:**
 
 ```
-quix applications variables delete [<name>] [options]
+quix apps variables delete [<name>] [options]
 ```
 
 **Arguments:**

docs/Reference/applications/variables/edit.gen.md → docs/Reference/apps/variables/edit.gen.md

@@ -1,4 +1,4 @@
-# applications variables edit
+# apps variables edit
 
 ## Overview
 
@@ -9,7 +9,7 @@ Edits a new variable of the current application
 **Usage:**
 
 ```
-quix applications variables edit [options]
+quix apps variables edit [options]
 ```
 
 **Options:**

docs/Reference/applications/variables/export.gen.md → docs/Reference/apps/variables/export.gen.md

@@ -1,4 +1,4 @@
-# applications variables export
+# apps variables export
 
 ## Overview
 
@@ -9,7 +9,7 @@ Exports the variables from app.yaml to an .env file
 **Usage:**
 
 ```
-quix applications variables export [options]
+quix apps variables export [options]
 ```
 
 **Options:**

docs/Reference/applications/variables/import.gen.md → docs/Reference/apps/variables/import.gen.md

@@ -1,4 +1,4 @@
-# applications variables import
+# apps variables import
 
 ## Overview
 
@@ -9,7 +9,7 @@ Imports the .env file values to the app.yaml. The values from the .env file will
 **Usage:**
 
 ```
-quix applications variables import [options]
+quix apps variables import [options]
 ```
 
 **Options:**

docs/Reference/applications/variables/index.gen.md → docs/Reference/apps/variables/index.gen.md

@@ -1,4 +1,4 @@
-# applications variables
+# apps variables
 
 ## Overview
 
@@ -9,7 +9,7 @@ Manage your local application's variables
 **Usage:**
 
 ```
-quix applications variables [command] [options]
+quix apps variables [command] [options]
 ```
 
 **Commands:**

docs/Reference/applications/variables/list.gen.md → docs/Reference/apps/variables/list.gen.md

@@ -1,4 +1,4 @@
-# applications variables list
+# apps variables list
 
 ## Overview
 
@@ -9,7 +9,7 @@ Lists the variables of the current application
 **Usage:**
 
 ```
-quix applications variables list [options]
+quix apps variables list [options]
 ```
 
 **Options:**

docs/Reference/pipeline/broker/down.gen.md → docs/Reference/broker/down.gen.md

@@ -1,15 +1,15 @@
-# pipeline broker down
+# broker down
 
 ## Overview
 
 Stop the broker instance of the local pipeline and all the services depending on it
 
-**Aliases:** `down`, `stop`
+**Aliases:** `down`
 
 **Usage:**
 
 ```
-quix pipeline broker down [options]
+quix broker down [options]
 ```
 
 **Options:**

docs/Reference/pipeline/broker/down.md → docs/Reference/broker/down.md

@@ -4,7 +4,7 @@
 
 ## How It Works
 
-The `quix pipeline broker down` command stops your local broker instance along with all the services that depend on it. When executed, it stops and removes the Docker containers defined in the `compose.yaml` file, effectively shutting down the local broker environment.
+The `quix broker down` command stops your local broker instance along with all the services that depend on it. When executed, it stops and removes the Docker containers defined in the `compose.local.yaml` file, effectively shutting down the local broker environment.
 
 If the force option is used, the command bypasses all safety checks, allowing for an immediate shutdown without any prompts or checks.
 
@@ -17,7 +17,7 @@ This ensures that your local environment is cleanly stopped and all resources ar
 To stop your local broker, use the following command:
 
 ```bash
-$ quix pipeline broker down
+$ quix broker down
 ```
 
 This command stops and removes the Docker containers:

docs/Reference/pipeline/broker/index.gen.md → docs/Reference/broker/index.gen.md

@@ -1,4 +1,4 @@
-# pipeline broker
+# broker
 
 ## Overview
 
@@ -9,11 +9,12 @@ Manage the broker instance of the local pipeline
 **Usage:**
 
 ```
-quix pipeline broker [command] [options]
+quix broker [command] [options]
 ```
 
 **Commands:**
 
 - [down](down.md) : Stop the broker instance of the local pipeline and all the services depending on it
+- [topics](topics/index.md) : Manage your pipeline topics
 - [up](up.md) : Start the broker instance of the local pipeline
 

docs/Reference/broker/topics/index.gen.md

@@ -0,0 +1,20 @@
+# broker topics
+
+## Overview
+
+Manage your pipeline topics
+
+**Aliases:** `topics`, `topic`, `tpc`
+
+**Usage:**
+
+```
+quix broker topics [command] [options]
+```
+
+**Commands:**
+
+- [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
+

docs/Reference/broker/topics/list.gen.md

@@ -0,0 +1,20 @@
+# broker topics list
+
+## Overview
+
+List your pipeline broker topics
+
+**Aliases:** `list`, `ls`
+
+**Usage:**
+
+```
+quix broker topics list [options]
+```
+
+**Options:**
+
+- `-o, --output <json|table>` : Output type of the retrieved data
+- `--directory <directory>` : If specified, it will use that directory instead of the current one
+- `-b, --broker-address <broker-address>` : The broker address to connect to [default: localhost:19092]
+

docs/Reference/broker/topics/list.md

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