Quix-59626: adding index files (#22)

* adding index files

README.md

@@ -105,7 +105,7 @@ quix login <patToken>
 
 ### Get Started
 
-After setting up your context and logging in you will be able to access your Quix organisation. For more information visit [Quix Docs](https://quix.io/docs/get-started/cli.html).
+After setting up your context and logging in you will be able to access your Quix organisation. For more information visit [Quix Docs](https://quix.io/docs/cli/overview.html).
 
 ### Using dedicated Quix clusters
 

docs/Reference/applications/index.gen.md

@@ -0,0 +1,20 @@
+# applications
+
+## Overview
+
+Manage the applications of an environment
+
+**Aliases:** applications, application, apps, app
+
+**Usage:**
+
+```
+quix applications [command] [options]
+```
+
+**Commands:**
+
+- [get](get.md) : Get an application in the specified environment
+- [library](library\index.md) : Manage the library items of an environment
+- [list](list.md) : Get all applications in the specified environment
+

docs/Reference/applications/index.md

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

docs/Reference/applications/library/index.gen.md

@@ -0,0 +1,18 @@
+# applications library
+
+## Overview
+
+Manage the library items of an environment
+
+**Aliases:** library
+
+**Usage:**
+
+```
+quix applications library [command] [options]
+```
+
+**Commands:**
+
+- [list](list.md) : Get all library items
+

docs/Reference/applications/library/index.md

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

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

@@ -0,0 +1,21 @@
+# contexts broker
+
+## Overview
+
+Manage the local broker of the current context
+
+**Aliases:** broker
+
+**Usage:**
+
+```
+quix contexts broker [command] [options]
+```
+
+**Commands:**
+
+- [disable](disable.md) : Disables the use of a local broker of the current context
+- [enable](enable.md) : Enables the use of a local broker of the current context
+- [set](set.md) : Sets the address for the local broker of the current context
+- [toggle](toggle.md) : Toggles the usage of a local broker of the current context
+

docs/Reference/contexts/broker/index.md

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

docs/Reference/contexts/environments/index.gen.md

@@ -0,0 +1,20 @@
+# contexts environments
+
+## Overview
+
+Manage the default environment
+
+**Aliases:** environments, environment, envs, env, workspaces, workspace
+
+**Usage:**
+
+```
+quix contexts environments [command] [options]
+```
+
+**Commands:**
+
+- [clear](clear.md) : Unset the default environment of the current context
+- [get](get.md) : Get the default environment of the current context
+- [use](use.md) : Select the default environment for the current context
+

docs/Reference/contexts/environments/index.md

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

docs/Reference/contexts/index.gen.md

@@ -0,0 +1,25 @@
+# contexts
+
+## Overview
+
+Manage the contexts for the CLI
+
+**Aliases:** contexts, context, ctx
+
+**Usage:**
+
+```
+quix contexts [command] [options]
+```
+
+**Commands:**
+
+- [broker](broker\index.md) : Manage the local broker of the current context
+- [create](create.md) : Add a new context to the CLI
+- [current](current.md) : Gets information about the current context
+- [delete](delete.md) : Remove a context from the CLI
+- [environments](environments\index.md) : Manage the default environment
+- [list](list.md) : Get all contexts
+- [reset](reset.md) : Resets your context to defaults
+- [use](use.md) : Uses the specified context
+

docs/Reference/contexts/index.md

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

docs/Reference/deployments/index.gen.md

@@ -0,0 +1,23 @@
+# deployments
+
+## Overview
+
+Manage the deployments of an environment
+
+**Aliases:** deployments, deployment
+
+**Usage:**
+
+```
+quix deployments [command] [options]
+```
+
+**Commands:**
+
+- [get](get.md) : Get the details for a deployment
+- [list](list.md) : Get the information for all the deployments in an environment
+- [logs](logs.md) : Get deployments logs
+- [metrics](metrics.md) : Get deployments metrics
+- [start](start.md) : Start a deployment
+- [stop](stop.md) : Stop a deployment
+

docs/Reference/deployments/index.md

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

docs/Reference/environments/index.gen.md

@@ -0,0 +1,21 @@
+# environments
+
+## Overview
+
+Manage the environments
+
+**Aliases:** environments, environment, envs, env, workspaces, workspace
+
+**Usage:**
+
+```
+quix environments [command] [options]
+```
+
+**Commands:**
+
+- [get](get.md) : Retrieves details of a specific environment accessible to the currently authenticated user
+- [list](list.md) : List all environments the current user has access to
+- [sync](sync.md) : Sync your environment based on the attached project
+- [use](use.md) : Select the default environment for the current context
+

docs/Reference/environments/index.md

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

docs/Reference/local/applications/index.gen.md

@@ -0,0 +1,21 @@
+# local applications
+
+## Overview
+
+Manage your local applications
+
+**Aliases:** applications, application, apps, app
+
+**Usage:**
+
+```
+quix local applications [command] [options]
+```
+
+**Commands:**
+
+- [convert](convert.md) : Converts applications from and to library item format
+- [create](create.md) : Creates an application locally
+- [list](list.md) : lists local applications
+- [variables](variables\index.md) : Manage your local application's variables
+

docs/Reference/local/applications/index.md

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

docs/Reference/local/applications/variables/create.gen.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-Edits a variable of the current application
+Creates a variable of the current application
 
 **Aliases:** create, add
 

docs/Reference/local/applications/variables/edit.gen.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-Creates a new variable of the current application
+Edits a new variable of the current application
 
 **Aliases:** edit
 

docs/Reference/local/applications/variables/import.gen.md

@@ -16,6 +16,5 @@ quix local applications variables import [options]
 
 - `--env-file-name <env-file-name>` : [default: .env]
 - `--directory <directory>` : Base directory (defaults to current directory)
-- `--from-app-variables` : If enabled the variables from the .env file will take preference over the ones in the app.yaml file [default: False]
 - `--reset` : Removes all variables from the app.yaml file and adds them from the .env file [default: False]
 

docs/Reference/local/applications/variables/index.gen.md

@@ -0,0 +1,23 @@
+# local applications variables
+
+## Overview
+
+Manage your local application's variables
+
+**Aliases:** variables, variable, vars, var
+
+**Usage:**
+
+```
+quix local applications variables [command] [options]
+```
+
+**Commands:**
+
+- [create](create.md) : Creates a variable of the current application
+- [delete](delete.md) : Deletes a variable of the current application
+- [edit](edit.md) : Edits a new variable of the current application
+- [export](export.md) : Exports the variables from app.yaml to an .env file
+- [import](import.md) : Imports the .env file values to the app.yaml. The values from the .env file will replace the ones in the app.yaml file
+- [list](list.md) : Lists the variables of the current application
+

docs/Reference/local/applications/variables/index.md

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

docs/Reference/local/index.gen.md

@@ -0,0 +1,21 @@
+# local
+
+## Overview
+
+Performs local related operations
+
+**Aliases:** local
+
+**Usage:**
+
+```
+quix local [command] [options]
+```
+
+**Commands:**
+
+- [applications](applications\index.md) : Manage your local applications
+- [pipeline](pipeline\index.md) : Manage your local pipeline and your 'quix.yaml'
+- [init](init.md) : Generate the initial Quix files based on the existing repository
+- [ide](ide.md) : Setup everything needed for local application development and open your local IDE
+

docs/Reference/local/index.md

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

docs/Reference/local/pipeline/deployments/index.gen.md

@@ -0,0 +1,22 @@
+# local pipeline deployments
+
+## Overview
+
+Manage the local deployments
+
+**Aliases:** deployments, deployment
+
+**Usage:**
+
+```
+quix local pipeline deployments [command] [options]
+```
+
+**Commands:**
+
+- [create](create.md) : Get a local deployment
+- [delete](delete.md) : Get a local deployment
+- [edit](edit.md) : Get a local deployment
+- [get](get.md) : Get a local deployment
+- [list](list.md) : List the local deployments
+

docs/Reference/local/pipeline/deployments/index.md

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

docs/Reference/local/pipeline/index.gen.md

@@ -0,0 +1,23 @@
+# local pipeline
+
+## Overview
+
+Manage your local pipeline and your 'quix.yaml'
+
+**Aliases:** pipeline, pipe
+
+**Usage:**
+
+```
+quix local pipeline [command] [options]
+```
+
+**Commands:**
+
+- [view](view.md) : Create and preview a mermaid diagram of the pipeline
+- [deployments](deployments\index.md) : Manage the local deployments
+- [update](update.md) : Update 'quix.yaml' with the new local applications and update the variables of the existing deployments
+- [sync](sync.md) : Synchronize your local pipeline to Quix Cloud.
+- [up](up.md) : Run your pipeline using docker compose
+- [down](down.md) : Stop the execution of your local pipeline
+

docs/Reference/local/pipeline/index.md

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

docs/Reference/organisations/index.gen.md

@@ -0,0 +1,18 @@
+# organisations
+
+## Overview
+
+Manage your organisation
+
+**Aliases:** organisations, organisation, organizations, organization, orgs, org
+
+**Usage:**
+
+```
+quix organisations [command] [options]
+```
+
+**Commands:**
+
+- [get](get.md) : Gets the organisation details the currently authenticated user belongs to
+

docs/Reference/organisations/index.md

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

docs/Reference/projects/index.gen.md

@@ -0,0 +1,20 @@
+# projects
+
+## Overview
+
+Manage the projects of the current organisation
+
+**Aliases:** projects, project, repositories, repository, repos, repo
+
+**Usage:**
+
+```
+quix projects [command] [options]
+```
+
+**Commands:**
+
+- [get](get.md) : Get all projects of the current organisation
+- [list](list.md) : Get all projects of the current organisation
+- [patch](patch.md) : Edit individual properties of a project
+

docs/Reference/projects/index.md

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