From caeec17d2613b7150fba0bec39e2d003d6b79523 Mon Sep 17 00:00:00 2001 From: emanuel-quix <124801336+emanuel-quix@users.noreply.github.com> Date: Fri, 21 Jun 2024 10:50:22 +0100 Subject: [PATCH] Updating refactored commands docs (#35) --- .../{local => }/applications/convert.gen.md | 6 +- .../{local => }/applications/convert.md | 0 .../{local => }/applications/create.gen.md | 8 +- .../{local => }/applications/create.md | 4 +- docs/Reference/applications/index.gen.md | 11 +- docs/Reference/applications/library/list.md | 18 - docs/Reference/applications/list.gen.md | 13 +- docs/Reference/applications/list.md | 28 +- .../applications/variables/create.gen.md | 6 +- .../applications/variables/create.md | 4 +- .../applications/variables/delete.gen.md | 6 +- .../applications/variables/delete.md | 4 +- .../applications/variables/edit.gen.md | 6 +- .../applications/variables/edit.md | 4 +- .../applications/variables/export.gen.md | 38 +- .../applications/variables/export.md | 4 +- .../applications/variables/import.gen.md | 36 +- .../applications/variables/import.md | 8 +- .../applications/variables/index.gen.md | 6 +- .../{library => variables}/index.md | 0 .../applications/variables/list.gen.md | 6 +- .../applications/variables/list.md | 4 +- .../Reference/{local => }/broker/index.gen.md | 4 +- .../{deployments => broker}/index.md | 0 .../{ => cloud}/applications/get.gen.md | 44 +-- .../Reference/{ => cloud}/applications/get.md | 0 .../Reference/cloud/applications/index.gen.md | 20 + .../applications}/index.md | 0 .../applications/library/index.gen.md | 6 +- .../applications/library}/index.md | 0 .../applications/library/list.gen.md | 6 +- .../cloud/applications/library/list.md | 1 + docs/Reference/cloud/applications/list.gen.md | 22 ++ .../{local => cloud}/applications/list.md | 2 +- .../{ => cloud}/deployments/get.gen.md | 6 +- docs/Reference/{ => cloud}/deployments/get.md | 0 .../{ => cloud}/deployments/index.gen.md | 6 +- .../variables => cloud/deployments}/index.md | 0 .../{ => cloud}/deployments/list.gen.md | 6 +- .../Reference/{ => cloud}/deployments/list.md | 0 .../{ => cloud}/deployments/logs.gen.md | 6 +- .../Reference/{ => cloud}/deployments/logs.md | 0 .../{ => cloud}/deployments/metrics.gen.md | 6 +- .../{ => cloud}/deployments/metrics.md | 0 .../{ => cloud}/deployments/start.gen.md | 6 +- .../{ => cloud}/deployments/start.md | 0 .../{ => cloud}/deployments/stop.gen.md | 6 +- .../Reference/{ => cloud}/deployments/stop.md | 0 .../{ => cloud}/environments/get.gen.md | 44 +-- .../Reference/{ => cloud}/environments/get.md | 0 .../{ => cloud}/environments/index.gen.md | 8 +- .../broker => cloud/environments}/index.md | 0 .../{ => cloud}/environments/list.gen.md | 6 +- .../{ => cloud}/environments/list.md | 0 .../{ => cloud}/environments/sync.gen.md | 6 +- .../{ => cloud}/environments/sync.md | 0 .../{ => cloud}/environments/use.gen.md | 36 +- docs/Reference/cloud/environments/use.md | 5 + docs/Reference/cloud/index.gen.md | 24 ++ docs/Reference/{local => cloud}/index.md | 0 .../{ => cloud}/organisations/get.gen.md | 6 +- .../organisations}/get.md | 0 .../{ => cloud}/organisations/index.gen.md | 6 +- .../organisations}/index.md | 0 .../Reference/{ => cloud}/projects/get.gen.md | 6 +- .../{organisations => cloud/projects}/get.md | 0 .../{ => cloud}/projects/index.gen.md | 6 +- .../pipeline => cloud/projects}/index.md | 0 .../{ => cloud}/projects/list.gen.md | 6 +- .../deployments => cloud/projects}/list.md | 0 .../{ => cloud}/projects/patch.gen.md | 6 +- docs/Reference/{ => cloud}/projects/patch.md | 0 docs/Reference/{ => cloud}/topics/get.gen.md | 6 +- .../{projects => cloud/topics}/get.md | 0 .../Reference/{ => cloud}/topics/index.gen.md | 6 +- .../{organisations => cloud/topics}/index.md | 0 docs/Reference/{ => cloud}/topics/list.gen.md | 6 +- .../{projects => cloud/topics}/list.md | 0 docs/Reference/{ => cloud}/users/audit.gen.md | 6 +- docs/Reference/{ => cloud}/users/audit.md | 0 .../{ => cloud}/users/current.gen.md | 6 +- docs/Reference/{ => cloud}/users/current.md | 0 docs/Reference/{ => cloud}/users/index.gen.md | 8 +- .../{projects => cloud/users}/index.md | 0 docs/Reference/{ => cloud}/users/list.gen.md | 6 +- .../Reference/{topics => cloud/users}/list.md | 0 .../{ => cloud}/users/permissions/copy.gen.md | 6 +- .../{ => cloud}/users/permissions/copy.md | 0 .../users/permissions/delete.gen.md | 6 +- .../{ => cloud}/users/permissions/delete.md | 0 .../{ => cloud}/users/permissions/edit.gen.md | 6 +- .../{ => cloud}/users/permissions/edit.md | 0 .../{ => cloud}/users/permissions/get.gen.md | 6 +- .../{ => cloud}/users/permissions/get.md | 0 .../users/permissions/index.gen.md | 6 +- .../users/permissions}/index.md | 0 .../{ => cloud}/users/permissions/list.gen.md | 6 +- .../{ => cloud}/users/permissions/list.md | 0 .../{ => cloud}/users/permissions/set.gen.md | 6 +- .../{ => cloud}/users/permissions/set.md | 0 .../{ => cloud}/users/tokens/create.gen.md | 46 +-- .../users/tokens}/create.md | 0 .../{ => cloud}/users/tokens/edit.gen.md | 6 +- .../users/tokens}/edit.md | 0 .../{ => cloud}/users/tokens/index.gen.md | 6 +- .../{users => cloud/users/tokens}/index.md | 0 .../{ => cloud}/users/tokens/list.gen.md | 6 +- .../{users => cloud/users/tokens}/list.md | 0 .../{ => cloud}/users/tokens/revoke.gen.md | 6 +- .../{ => cloud}/users/tokens/revoke.md | 0 .../{ => cloud}/utils/note-output.md | 0 docs/Reference/{ => cloud}/utils/tip-use.md | 0 docs/Reference/contexts/broker/cloud.gen.md | 11 +- docs/Reference/contexts/broker/index.gen.md | 10 +- docs/Reference/contexts/broker/local.gen.md | 10 +- docs/Reference/contexts/broker/set.gen.md | 12 +- docs/Reference/contexts/broker/set.md | 2 +- docs/Reference/contexts/create.gen.md | 8 +- docs/Reference/contexts/current.gen.md | 2 +- docs/Reference/contexts/delete.gen.md | 2 +- .../contexts/environments/clear.gen.md | 2 +- .../contexts/environments/get.gen.md | 2 +- .../contexts/environments/index.gen.md | 2 +- .../contexts/environments/use.gen.md | 2 +- docs/Reference/contexts/index.gen.md | 6 +- docs/Reference/contexts/list.gen.md | 2 +- docs/Reference/contexts/reset.gen.md | 2 +- docs/Reference/contexts/use.gen.md | 2 +- docs/Reference/environments/use.md | 5 - docs/Reference/{local => }/ide.gen.md | 8 +- docs/Reference/{local => }/ide.md | 12 +- docs/Reference/{local => }/init.gen.md | 6 +- docs/Reference/{local => }/init.md | 10 +- .../Reference/local/applications/index.gen.md | 21 -- docs/Reference/local/applications/list.gen.md | 19 - docs/Reference/local/index.gen.md | 22 -- docs/Reference/local/variables/export.gen.md | 21 -- docs/Reference/local/variables/export.md | 1 - docs/Reference/login.gen.md | 2 +- docs/Reference/login.md | 2 +- docs/Reference/logout.gen.md | 14 + docs/Reference/logout.md | 1 + .../{local => pipeline}/broker/down.gen.md | 8 +- .../{local => pipeline}/broker/down.md | 6 +- docs/Reference/pipeline/broker/index.gen.md | 19 + .../permissions => pipeline/broker}/index.md | 0 .../{local => pipeline}/broker/up.gen.md | 8 +- .../{local => pipeline}/broker/up.md | 4 +- .../pipeline/deployments/create.gen.md | 48 +-- .../tokens => pipeline/deployments}/create.md | 0 .../pipeline/deployments/delete.gen.md | 44 +-- .../pipeline/deployments/delete.md | 0 .../pipeline/deployments/edit.gen.md | 46 +-- .../tokens => pipeline/deployments}/edit.md | 0 .../pipeline/deployments/get.gen.md | 6 +- .../{topics => pipeline/deployments}/get.md | 0 .../pipeline/deployments/index.gen.md | 8 +- .../tokens => pipeline/deployments}/index.md | 0 .../pipeline/deployments/list.gen.md | 38 +- .../tokens => pipeline/deployments}/list.md | 0 .../{local => }/pipeline/down.gen.md | 36 +- docs/Reference/{local => }/pipeline/down.md | 4 +- .../{local => }/pipeline/index.gen.md | 13 +- docs/Reference/pipeline/index.md | 1 + .../{local => }/pipeline/status.gen.md | 6 +- docs/Reference/{local => }/pipeline/status.md | 6 +- .../{local => }/pipeline/sync.gen.md | 8 +- docs/Reference/{local => }/pipeline/sync.md | 6 +- docs/Reference/{local => }/pipeline/up.gen.md | 6 +- docs/Reference/{local => }/pipeline/up.md | 8 +- .../{local => }/pipeline/update.gen.md | 6 +- docs/Reference/{local => }/pipeline/update.md | 2 +- .../{local => }/pipeline/view.gen.md | 6 +- docs/Reference/{local => }/pipeline/view.md | 6 +- docs/Reference/sdk/broker/cloud.gen.md | 21 ++ docs/Reference/sdk/broker/cloud.md | 1 + docs/Reference/sdk/broker/index.gen.md | 21 ++ docs/Reference/sdk/broker/index.md | 1 + docs/Reference/sdk/broker/local.gen.md | 20 + docs/Reference/sdk/broker/local.md | 5 + docs/Reference/sdk/broker/set.gen.md | 26 ++ docs/Reference/sdk/broker/set.md | 4 + docs/Reference/sdk/broker/update.gen.md | 20 + docs/Reference/sdk/broker/update.md | 1 + docs/Reference/sdk/index.gen.md | 18 + docs/Reference/sdk/index.md | 1 + docs/Reference/status.gen.md | 4 +- docs/Reference/status.md | 2 +- docs/Reference/update.gen.md | 2 +- docs/Reference/use.gen.md | 2 +- docs/cli-github-actions.md | 2 +- docs/cli-quickstart.md | 20 +- docs/cli-template.md | 6 +- mkdocs.yml | 355 +++++++++--------- 194 files changed, 972 insertions(+), 818 deletions(-) rename docs/Reference/{local => }/applications/convert.gen.md (79%) rename docs/Reference/{local => }/applications/convert.md (100%) rename docs/Reference/{local => }/applications/create.gen.md (76%) rename docs/Reference/{local => }/applications/create.md (88%) delete mode 100644 docs/Reference/applications/library/list.md rename docs/Reference/{local => }/applications/variables/create.gen.md (80%) rename docs/Reference/{local => }/applications/variables/create.md (85%) rename docs/Reference/{local => }/applications/variables/delete.gen.md (61%) rename docs/Reference/{local => }/applications/variables/delete.md (80%) rename docs/Reference/{local => }/applications/variables/edit.gen.md (82%) rename docs/Reference/{local => }/applications/variables/edit.md (85%) rename docs/Reference/{local => }/applications/variables/export.gen.md (70%) rename docs/Reference/{local => }/applications/variables/export.md (87%) rename docs/Reference/{local => }/applications/variables/import.gen.md (74%) rename docs/Reference/{local => }/applications/variables/import.md (71%) rename docs/Reference/{local => }/applications/variables/index.gen.md (82%) rename docs/Reference/applications/{library => variables}/index.md (100%) rename docs/Reference/{local => }/applications/variables/list.gen.md (62%) rename docs/Reference/{local => }/applications/variables/list.md (87%) rename docs/Reference/{local => }/broker/index.gen.md (82%) rename docs/Reference/{deployments => broker}/index.md (100%) rename docs/Reference/{ => cloud}/applications/get.gen.md (70%) rename docs/Reference/{ => cloud}/applications/get.md (100%) create mode 100644 docs/Reference/cloud/applications/index.gen.md rename docs/Reference/{environments => cloud/applications}/index.md (100%) rename docs/Reference/{ => cloud}/applications/library/index.gen.md (57%) rename docs/Reference/{local/applications => cloud/applications/library}/index.md (100%) rename docs/Reference/{ => cloud}/applications/library/list.gen.md (68%) create mode 100644 docs/Reference/cloud/applications/library/list.md create mode 100644 docs/Reference/cloud/applications/list.gen.md rename docs/Reference/{local => cloud}/applications/list.md (95%) rename docs/Reference/{ => cloud}/deployments/get.gen.md (80%) rename docs/Reference/{ => cloud}/deployments/get.md (100%) rename docs/Reference/{ => cloud}/deployments/index.gen.md (79%) rename docs/Reference/{local/applications/variables => cloud/deployments}/index.md (100%) rename docs/Reference/{ => cloud}/deployments/list.gen.md (81%) rename docs/Reference/{ => cloud}/deployments/list.md (100%) rename docs/Reference/{ => cloud}/deployments/logs.gen.md (77%) rename docs/Reference/{ => cloud}/deployments/logs.md (100%) rename docs/Reference/{ => cloud}/deployments/metrics.gen.md (50%) rename docs/Reference/{ => cloud}/deployments/metrics.md (100%) rename docs/Reference/{ => cloud}/deployments/start.gen.md (51%) rename docs/Reference/{ => cloud}/deployments/start.md (100%) rename docs/Reference/{ => cloud}/deployments/stop.gen.md (51%) rename docs/Reference/{ => cloud}/deployments/stop.md (100%) rename docs/Reference/{ => cloud}/environments/get.gen.md (72%) rename docs/Reference/{ => cloud}/environments/get.md (100%) rename docs/Reference/{ => cloud}/environments/index.gen.md (62%) rename docs/Reference/{local/broker => cloud/environments}/index.md (100%) rename docs/Reference/{ => cloud}/environments/list.gen.md (65%) rename docs/Reference/{ => cloud}/environments/list.md (100%) rename docs/Reference/{ => cloud}/environments/sync.gen.md (76%) rename docs/Reference/{ => cloud}/environments/sync.md (100%) rename docs/Reference/{ => cloud}/environments/use.gen.md (62%) create mode 100644 docs/Reference/cloud/environments/use.md create mode 100644 docs/Reference/cloud/index.gen.md rename docs/Reference/{local => cloud}/index.md (100%) rename docs/Reference/{ => cloud}/organisations/get.gen.md (69%) rename docs/Reference/{local/pipeline/deployments => cloud/organisations}/get.md (100%) rename docs/Reference/{ => cloud}/organisations/index.gen.md (51%) rename docs/Reference/{local/pipeline/deployments => cloud/organisations}/index.md (100%) rename docs/Reference/{ => cloud}/projects/get.gen.md (71%) rename docs/Reference/{organisations => cloud/projects}/get.md (100%) rename docs/Reference/{ => cloud}/projects/index.gen.md (67%) rename docs/Reference/{local/pipeline => cloud/projects}/index.md (100%) rename docs/Reference/{ => cloud}/projects/list.gen.md (66%) rename docs/Reference/{local/pipeline/deployments => cloud/projects}/list.md (100%) rename docs/Reference/{ => cloud}/projects/patch.gen.md (87%) rename docs/Reference/{ => cloud}/projects/patch.md (100%) rename docs/Reference/{ => cloud}/topics/get.gen.md (69%) rename docs/Reference/{projects => cloud/topics}/get.md (100%) rename docs/Reference/{ => cloud}/topics/index.gen.md (74%) rename docs/Reference/{organisations => cloud/topics}/index.md (100%) rename docs/Reference/{ => cloud}/topics/list.gen.md (68%) rename docs/Reference/{projects => cloud/topics}/list.md (100%) rename docs/Reference/{ => cloud}/users/audit.gen.md (92%) rename docs/Reference/{ => cloud}/users/audit.md (100%) rename docs/Reference/{ => cloud}/users/current.gen.md (68%) rename docs/Reference/{ => cloud}/users/current.md (100%) rename docs/Reference/{ => cloud}/users/index.gen.md (72%) rename docs/Reference/{projects => cloud/users}/index.md (100%) rename docs/Reference/{ => cloud}/users/list.gen.md (66%) rename docs/Reference/{topics => cloud/users}/list.md (100%) rename docs/Reference/{ => cloud}/users/permissions/copy.gen.md (64%) rename docs/Reference/{ => cloud}/users/permissions/copy.md (100%) rename docs/Reference/{ => cloud}/users/permissions/delete.gen.md (63%) rename docs/Reference/{ => cloud}/users/permissions/delete.md (100%) rename docs/Reference/{ => cloud}/users/permissions/edit.gen.md (77%) rename docs/Reference/{ => cloud}/users/permissions/edit.md (100%) rename docs/Reference/{ => cloud}/users/permissions/get.gen.md (76%) rename docs/Reference/{ => cloud}/users/permissions/get.md (100%) rename docs/Reference/{ => cloud}/users/permissions/index.gen.md (85%) rename docs/Reference/{topics => cloud/users/permissions}/index.md (100%) rename docs/Reference/{ => cloud}/users/permissions/list.gen.md (63%) rename docs/Reference/{ => cloud}/users/permissions/list.md (100%) rename docs/Reference/{ => cloud}/users/permissions/set.gen.md (75%) rename docs/Reference/{ => cloud}/users/permissions/set.md (100%) rename docs/Reference/{ => cloud}/users/tokens/create.gen.md (79%) rename docs/Reference/{local/pipeline/deployments => cloud/users/tokens}/create.md (100%) rename docs/Reference/{ => cloud}/users/tokens/edit.gen.md (86%) rename docs/Reference/{local/pipeline/deployments => cloud/users/tokens}/edit.md (100%) rename docs/Reference/{ => cloud}/users/tokens/index.gen.md (79%) rename docs/Reference/{users => cloud/users/tokens}/index.md (100%) rename docs/Reference/{ => cloud}/users/tokens/list.gen.md (65%) rename docs/Reference/{users => cloud/users/tokens}/list.md (100%) rename docs/Reference/{ => cloud}/users/tokens/revoke.gen.md (69%) rename docs/Reference/{ => cloud}/users/tokens/revoke.md (100%) rename docs/Reference/{ => cloud}/utils/note-output.md (100%) rename docs/Reference/{ => cloud}/utils/tip-use.md (100%) delete mode 100644 docs/Reference/environments/use.md rename docs/Reference/{local => }/ide.gen.md (68%) rename docs/Reference/{local => }/ide.md (85%) rename docs/Reference/{local => }/init.gen.md (88%) rename docs/Reference/{local => }/init.md (61%) delete mode 100644 docs/Reference/local/applications/index.gen.md delete mode 100644 docs/Reference/local/applications/list.gen.md delete mode 100644 docs/Reference/local/index.gen.md delete mode 100644 docs/Reference/local/variables/export.gen.md delete mode 100644 docs/Reference/local/variables/export.md create mode 100644 docs/Reference/logout.gen.md create mode 100644 docs/Reference/logout.md rename docs/Reference/{local => pipeline}/broker/down.gen.md (52%) rename docs/Reference/{local => pipeline}/broker/down.md (82%) create mode 100644 docs/Reference/pipeline/broker/index.gen.md rename docs/Reference/{users/permissions => pipeline/broker}/index.md (100%) rename docs/Reference/{local => pipeline}/broker/up.gen.md (62%) rename docs/Reference/{local => pipeline}/broker/up.md (87%) rename docs/Reference/{local => }/pipeline/deployments/create.gen.md (73%) rename docs/Reference/{users/tokens => pipeline/deployments}/create.md (100%) rename docs/Reference/{local => }/pipeline/deployments/delete.gen.md (58%) rename docs/Reference/{local => }/pipeline/deployments/delete.md (100%) rename docs/Reference/{local => }/pipeline/deployments/edit.gen.md (69%) rename docs/Reference/{users/tokens => pipeline/deployments}/edit.md (100%) rename docs/Reference/{local => }/pipeline/deployments/get.gen.md (70%) rename docs/Reference/{topics => pipeline/deployments}/get.md (100%) rename docs/Reference/{local => }/pipeline/deployments/index.gen.md (64%) rename docs/Reference/{users/tokens => pipeline/deployments}/index.md (100%) rename docs/Reference/{local => }/pipeline/deployments/list.gen.md (64%) rename docs/Reference/{users/tokens => pipeline/deployments}/list.md (100%) rename docs/Reference/{local => }/pipeline/down.gen.md (70%) rename docs/Reference/{local => }/pipeline/down.md (89%) rename docs/Reference/{local => }/pipeline/index.gen.md (63%) create mode 100644 docs/Reference/pipeline/index.md rename docs/Reference/{local => }/pipeline/status.gen.md (71%) rename docs/Reference/{local => }/pipeline/status.md (73%) rename docs/Reference/{local => }/pipeline/sync.gen.md (76%) rename docs/Reference/{local => }/pipeline/sync.md (91%) rename docs/Reference/{local => }/pipeline/up.gen.md (83%) rename docs/Reference/{local => }/pipeline/up.md (87%) rename docs/Reference/{local => }/pipeline/update.gen.md (89%) rename docs/Reference/{local => }/pipeline/update.md (98%) rename docs/Reference/{local => }/pipeline/view.gen.md (70%) rename docs/Reference/{local => }/pipeline/view.md (88%) create mode 100644 docs/Reference/sdk/broker/cloud.gen.md create mode 100644 docs/Reference/sdk/broker/cloud.md create mode 100644 docs/Reference/sdk/broker/index.gen.md create mode 100644 docs/Reference/sdk/broker/index.md create mode 100644 docs/Reference/sdk/broker/local.gen.md create mode 100644 docs/Reference/sdk/broker/local.md create mode 100644 docs/Reference/sdk/broker/set.gen.md create mode 100644 docs/Reference/sdk/broker/set.md create mode 100644 docs/Reference/sdk/broker/update.gen.md create mode 100644 docs/Reference/sdk/broker/update.md create mode 100644 docs/Reference/sdk/index.gen.md create mode 100644 docs/Reference/sdk/index.md diff --git a/docs/Reference/local/applications/convert.gen.md b/docs/Reference/applications/convert.gen.md similarity index 79% rename from docs/Reference/local/applications/convert.gen.md rename to docs/Reference/applications/convert.gen.md index 18ee1f0..e1ddc20 100644 --- a/docs/Reference/local/applications/convert.gen.md +++ b/docs/Reference/applications/convert.gen.md @@ -1,15 +1,15 @@ -# local applications convert +# applications convert ## Overview Converts applications from and to library item format -**Aliases:** convert +**Aliases:** `convert` **Usage:** ``` -quix local applications convert [options] +quix applications convert [options] ``` **Arguments:** diff --git a/docs/Reference/local/applications/convert.md b/docs/Reference/applications/convert.md similarity index 100% rename from docs/Reference/local/applications/convert.md rename to docs/Reference/applications/convert.md diff --git a/docs/Reference/local/applications/create.gen.md b/docs/Reference/applications/create.gen.md similarity index 76% rename from docs/Reference/local/applications/create.gen.md rename to docs/Reference/applications/create.gen.md index 82013b4..b678b38 100644 --- a/docs/Reference/local/applications/create.gen.md +++ b/docs/Reference/applications/create.gen.md @@ -1,15 +1,15 @@ -# local applications create +# applications create ## Overview -Creates an application locally +Creates a new application locally based on a code sample of the library -**Aliases:** create, add +**Aliases:** `create`, `add` **Usage:** ``` -quix local applications create [] [options] +quix applications create [] [options] ``` **Arguments:** diff --git a/docs/Reference/local/applications/create.md b/docs/Reference/applications/create.md similarity index 88% rename from docs/Reference/local/applications/create.md rename to docs/Reference/applications/create.md index 3b1a59d..01a94b1 100644 --- a/docs/Reference/local/applications/create.md +++ b/docs/Reference/applications/create.md @@ -2,7 +2,7 @@ ## How it Works -The `quix local applications create` command initializes a new application within your local environment based on the chosen library item. When executed, it creates the necessary file structure and configuration files for the specified application, ensuring that it is ready for development and integration with the Quix ecosystem. +The `quix applications create` command initializes a new application within your local environment based on the chosen library item. When executed, it creates the necessary file structure and configuration files for the specified application, ensuring that it is ready for development and integration with the Quix ecosystem. When you run this command, it will prompt you to select a library item from an interactive list if no arguments are provided. This list includes various predefined application templates such as data sources, transformations, and sinks. Once you select a library item, the command will guide you through naming the application and choosing its directory location. @@ -28,7 +28,7 @@ This setup facilitates a quick start to your development process, allowing you t When you execute the create local application command without any arguments: ``` -$ quix local applications create +$ quix applications create ``` The interactive command starts: diff --git a/docs/Reference/applications/index.gen.md b/docs/Reference/applications/index.gen.md index c6c5871..5cf18c8 100644 --- a/docs/Reference/applications/index.gen.md +++ b/docs/Reference/applications/index.gen.md @@ -2,9 +2,9 @@ ## Overview -Manage the applications of an environment +Manage your local applications and their variables -**Aliases:** applications, application, apps, app +**Aliases:** `applications`, `application`, `apps`, `app` **Usage:** @@ -14,7 +14,8 @@ 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 +- [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 +- [list](list.md) : Lists all the local applications of the project +- [variables](variables\index.md) : Manage your local application's variables diff --git a/docs/Reference/applications/library/list.md b/docs/Reference/applications/library/list.md deleted file mode 100644 index 03f0983..0000000 --- a/docs/Reference/applications/library/list.md +++ /dev/null @@ -1,18 +0,0 @@ -{% include-markdown './list.gen.md' %} - -## Example Usage - -When you enter the command without any options: - -``` -$ quix local applications list -``` - -A table containing all your local applications is printed: - -``` -ApplicationId | Name | Language | Dockerfile | RunEntryPoint | Default File --------------------------------|--------------------------------|----------|------------|---------------|----------------- -Event Detection Transformation | Event Detection Transformation | Python | dockerfile | main.py | quix_function.py -Starter Source | Starter Source | Python | dockerfile | main.py | main.py -``` \ No newline at end of file diff --git a/docs/Reference/applications/list.gen.md b/docs/Reference/applications/list.gen.md index d8cba37..f0e582b 100644 --- a/docs/Reference/applications/list.gen.md +++ b/docs/Reference/applications/list.gen.md @@ -2,21 +2,18 @@ ## Overview -Get all applications in the specified environment +Lists all the local applications of the project -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** ``` -quix applications list [] [options] +quix applications list [options] ``` -**Arguments:** - -- `` : The ID of the environment - **Options:** -- `-o, --output ` : Output type of the retrieved data +- `-o, --output ` : Output type of the retrieved data +- `-d, --directory ` : Base directory (defaults to current directory) diff --git a/docs/Reference/applications/list.md b/docs/Reference/applications/list.md index 48ddd21..20a4d33 100644 --- a/docs/Reference/applications/list.md +++ b/docs/Reference/applications/list.md @@ -1,30 +1,18 @@ {% include-markdown './list.gen.md' %} -## Example usage +## Example Usage -When you execute the list local applications variable command without any options: +When you enter the command without any options: ``` -$ quix local apps vars ls +$ quix applications list ``` -The interactive command starts. If your current directory is not an application directory, you are prompted to select the application for which you want to list the variables: +A table containing all your local applications is printed: ``` -? Select application: - -> Event Detection Transformation \Event Detection Transformation - Starter Source \Starter Source - ✗ Cancel -``` - -A table containing all your local application variables is printed: - -``` -✓ Found application 'Event Detection Transformation' - - Name | Default value | Description | Type | Is required? - --------|---------------|--------------------------------------------------|-------------|-------------- - input | f1-data | This is the input topic for f1 data | InputTopic | ✓ - output | hard-braking | This is the output topic for hard braking events | OutputTopic | ✓ +ApplicationId | Name | Language | Dockerfile | RunEntryPoint | Default File +-------------------------------|--------------------------------|----------|------------|---------------|----------------- +Event Detection Transformation | Event Detection Transformation | Python | dockerfile | main.py | quix_function.py +Starter Source | Starter Source | Python | dockerfile | main.py | main.py ``` \ No newline at end of file diff --git a/docs/Reference/local/applications/variables/create.gen.md b/docs/Reference/applications/variables/create.gen.md similarity index 80% rename from docs/Reference/local/applications/variables/create.gen.md rename to docs/Reference/applications/variables/create.gen.md index 3d38305..7d816fb 100644 --- a/docs/Reference/local/applications/variables/create.gen.md +++ b/docs/Reference/applications/variables/create.gen.md @@ -1,15 +1,15 @@ -# local applications variables create +# applications variables create ## Overview Creates a variable of the current application -**Aliases:** create, add +**Aliases:** `create`, `add` **Usage:** ``` -quix local applications variables create [options] +quix applications variables create [options] ``` **Options:** diff --git a/docs/Reference/local/applications/variables/create.md b/docs/Reference/applications/variables/create.md similarity index 85% rename from docs/Reference/local/applications/variables/create.md rename to docs/Reference/applications/variables/create.md index 284119c..e54b1ec 100644 --- a/docs/Reference/local/applications/variables/create.md +++ b/docs/Reference/applications/variables/create.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local apps vars create` command allows you to create new variables for your application through an interactive process. This command updates the `app.yaml` file with the new variables, ensuring your application configuration is current. +The `quix apps vars create` command allows you to create new variables for your application through an interactive process. This command updates the `app.yaml` file with the new variables, ensuring your application configuration is current. When you run the command, you are prompted to select an application (if not already in an application directory), choose the variable type (Input Topic, Output Topic, Free Text, Secret), and provide details such as the variable name, description, default value, and whether it is required. The new variable is then added to the `app.yaml` file. @@ -14,7 +14,7 @@ When you run the command, you are prompted to select an application (if not alre When you execute the create local variable command without any options: ``` -$ quix local apps vars create +$ quix apps vars create ``` The interactive command starts. If your current directory is not an application directory, you are prompted to select the application for which you want to edit variables: diff --git a/docs/Reference/local/applications/variables/delete.gen.md b/docs/Reference/applications/variables/delete.gen.md similarity index 61% rename from docs/Reference/local/applications/variables/delete.gen.md rename to docs/Reference/applications/variables/delete.gen.md index 3a19239..18bbde7 100644 --- a/docs/Reference/local/applications/variables/delete.gen.md +++ b/docs/Reference/applications/variables/delete.gen.md @@ -1,15 +1,15 @@ -# local applications variables delete +# applications variables delete ## Overview Deletes a variable of the current application -**Aliases:** delete, del, remove, rm +**Aliases:** `delete`, `del`, `remove`, `rm` **Usage:** ``` -quix local applications variables delete [] [options] +quix applications variables delete [] [options] ``` **Arguments:** diff --git a/docs/Reference/local/applications/variables/delete.md b/docs/Reference/applications/variables/delete.md similarity index 80% rename from docs/Reference/local/applications/variables/delete.md rename to docs/Reference/applications/variables/delete.md index 2f83026..35987da 100644 --- a/docs/Reference/local/applications/variables/delete.md +++ b/docs/Reference/applications/variables/delete.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local apps vars delete` command allows you to remove variables from your application through an interactive process. This command updates the `app.yaml` file by removing the specified variable, ensuring your application configuration is current. +The `quix apps vars delete` command allows you to remove variables from your application through an interactive process. This command updates the `app.yaml` file by removing the specified variable, ensuring your application configuration is current. When you run the command, you are prompted to select an application (if not already in an application directory), choose the variable you want to delete, and confirm the deletion. The variable is then removed from the `app.yaml` file. @@ -14,7 +14,7 @@ When you run the command, you are prompted to select an application (if not alre When you execute the delete local variable command without any options: ``` -$ quix local app vars delete +$ quix app vars delete ``` The interactive command starts. If your current directory is not an application directory, you are prompted to select the application for which you want to remove variables: diff --git a/docs/Reference/local/applications/variables/edit.gen.md b/docs/Reference/applications/variables/edit.gen.md similarity index 82% rename from docs/Reference/local/applications/variables/edit.gen.md rename to docs/Reference/applications/variables/edit.gen.md index 310f0cc..3eac0cd 100644 --- a/docs/Reference/local/applications/variables/edit.gen.md +++ b/docs/Reference/applications/variables/edit.gen.md @@ -1,15 +1,15 @@ -# local applications variables edit +# applications variables edit ## Overview Edits a new variable of the current application -**Aliases:** edit +**Aliases:** `edit` **Usage:** ``` -quix local applications variables edit [options] +quix applications variables edit [options] ``` **Options:** diff --git a/docs/Reference/local/applications/variables/edit.md b/docs/Reference/applications/variables/edit.md similarity index 85% rename from docs/Reference/local/applications/variables/edit.md rename to docs/Reference/applications/variables/edit.md index 63cb906..c94acca 100644 --- a/docs/Reference/local/applications/variables/edit.md +++ b/docs/Reference/applications/variables/edit.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local apps vars edit` command allows you to edit existing variables for your application through an interactive process. This command updates the `app.yaml` file with the modified variable values, ensuring your application configuration remains current. +The `quix apps vars edit` command allows you to edit existing variables for your application through an interactive process. This command updates the `app.yaml` file with the modified variable values, ensuring your application configuration remains current. When you run the command, you are prompted to select an application (if not already in an application directory), choose the variable you want to edit, and modify its details such as the variable type (Input Topic, Output Topic, Free Text, Secret), description, default value, and whether it is required. The updated variable is then saved to the `app.yaml` file. @@ -15,7 +15,7 @@ When you execute the edit local applications variable command without any option ``` -$ quix local apps vars edit +$ quix apps vars edit ``` The interactive command starts. If your current directory is not an application directory, you are prompted to select the application for which you want to edit the variables: diff --git a/docs/Reference/local/applications/variables/export.gen.md b/docs/Reference/applications/variables/export.gen.md similarity index 70% rename from docs/Reference/local/applications/variables/export.gen.md rename to docs/Reference/applications/variables/export.gen.md index 3dfbf06..4c4e2f9 100644 --- a/docs/Reference/local/applications/variables/export.gen.md +++ b/docs/Reference/applications/variables/export.gen.md @@ -1,21 +1,21 @@ -# local applications variables export - -## Overview - -Exports the variables from app.yaml to an .env file - -**Aliases:** export, exp, export-to-dotenv - -**Usage:** - -``` -quix local applications variables export [options] -``` - -**Options:** - -- `--workspace-id ` : The environment to use if your local debug broker is set to Quix Cloud +# applications variables export + +## Overview + +Exports the variables from app.yaml to an .env file + +**Aliases:** `export`, `exp`, `export-to-dotenv` + +**Usage:** + +``` +quix applications variables export [options] +``` + +**Options:** + +- `--workspace-id ` : The environment to use if your Sdk broker configuration is set to Quix Cloud - `--env-file-name ` : Set the name of the environment file [default: .env] - `--directory ` : Base directory (defaults to current directory) -- `--reset` : Removes all the values of existing env variables and adds them from the app.yaml file [default: False] - +- `--reset` : Removes all the values of existing env variables and adds them from the app.yaml file [default: False] + diff --git a/docs/Reference/local/applications/variables/export.md b/docs/Reference/applications/variables/export.md similarity index 87% rename from docs/Reference/local/applications/variables/export.md rename to docs/Reference/applications/variables/export.md index 90e57f4..bee2f60 100644 --- a/docs/Reference/local/applications/variables/export.md +++ b/docs/Reference/applications/variables/export.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local applications variables export` command exports variables from your `app.yaml` file to a `.env` file. This command simplifies the management of environment variables by maintaining them in a standardized format. An `.env` file is a simple text file used to set environment variables, which can be easily loaded into your application's runtime environment. +The `quix applications variables export` command exports variables from your `app.yaml` file to a `.env` file. This command simplifies the management of environment variables by maintaining them in a standardized format. An `.env` file is a simple text file used to set environment variables, which can be easily loaded into your application's runtime environment. When you run the command, you are prompted to select an application (if not already in an application directory). The command then exports the variables from the `app.yaml` file to an `.env` file in the specified directory. By default, the `.env` file will be created in the current directory with the name `.env`. @@ -38,7 +38,7 @@ These environment variables are crucial for ensuring that your application can c To export variables from your `app.yaml` file to an `.env` file, use the following command: ```bash -$ quix local applications variables export +$ quix applications variables export ``` !!! tip diff --git a/docs/Reference/local/applications/variables/import.gen.md b/docs/Reference/applications/variables/import.gen.md similarity index 74% rename from docs/Reference/local/applications/variables/import.gen.md rename to docs/Reference/applications/variables/import.gen.md index 5df2531..bf41c53 100644 --- a/docs/Reference/local/applications/variables/import.gen.md +++ b/docs/Reference/applications/variables/import.gen.md @@ -1,20 +1,20 @@ -# local applications variables import - -## Overview - -Imports the .env file values to the app.yaml. The values from the .env file will replace the ones in the app.yaml file - -**Aliases:** import, imp, import-from-dotenv - -**Usage:** - -``` -quix local applications variables import [options] -``` - -**Options:** - +# applications variables import + +## Overview + +Imports the .env file values to the app.yaml. The values from the .env file will replace the ones in the app.yaml file + +**Aliases:** `import`, `imp`, `import-from-dotenv` + +**Usage:** + +``` +quix applications variables import [options] +``` + +**Options:** + - `--env-file-name ` : Set the name of the environment file [default: .env] - `--directory ` : Base directory (defaults to current directory) -- `--reset` : Removes all variables from the app.yaml file and adds them from the .env file [default: False] - +- `--reset` : Removes all variables from the app.yaml file and adds them from the .env file [default: False] + diff --git a/docs/Reference/local/applications/variables/import.md b/docs/Reference/applications/variables/import.md similarity index 71% rename from docs/Reference/local/applications/variables/import.md rename to docs/Reference/applications/variables/import.md index c3622ee..2dc0236 100644 --- a/docs/Reference/local/applications/variables/import.md +++ b/docs/Reference/applications/variables/import.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local applications variables import` command updates the `app.yaml` file with variables from the `.env` file. This process ensures that the environment-specific configurations in the `.env` file are accurately reflected in the `app.yaml` file, which is used by your Quix applications. +The `quix applications variables import` command updates the `app.yaml` file with variables from the `.env` file. This process ensures that the environment-specific configurations in the `.env` file are accurately reflected in the `app.yaml` file, which is used by your Quix applications. - **Existing Variables**: If a variable from the `.env` file matches an existing variable in the `app.yaml` file, its value will be updated only if the `replaceAppVariables` flag is set to true. - **New Variables**: If a variable from the `.env` file does not exist in the `app.yaml` file, it will be added. The type of the new variable is determined based on its name: @@ -13,18 +13,18 @@ The `quix local applications variables import` command updates the `app.yaml` fi This ensures that your application configuration is kept up-to-date with the latest environment variables, making it easier to manage and deploy your applications consistently. !!! warning - It is generally better to manually edit the `app.yaml` file or use the CLI commands under [`quix local applications variables`](index.md) to ensure all configurations are correct and intentional. Regular use of this import command is not recommended. + It is generally better to manually edit the `app.yaml` file or use the CLI commands under [`quix applications variables`](index.md) to ensure all configurations are correct and intentional. Regular use of this import command is not recommended. ## Example usage ### Importing Environment Variables from an `.env` File to `app.yaml` -The `quix local applications variables import` command allows you to import variables from your `.env` file into the `app.yaml` file. This updates the application configuration with the values from the `.env` file. +The `quix applications variables import` command allows you to import variables from your `.env` file into the `app.yaml` file. This updates the application configuration with the values from the `.env` file. To use this command, you can run: ```bash -$ quix local apps vars import +$ quix apps vars import ``` !!! tip diff --git a/docs/Reference/local/applications/variables/index.gen.md b/docs/Reference/applications/variables/index.gen.md similarity index 82% rename from docs/Reference/local/applications/variables/index.gen.md rename to docs/Reference/applications/variables/index.gen.md index a8a8733..6ca5e46 100644 --- a/docs/Reference/local/applications/variables/index.gen.md +++ b/docs/Reference/applications/variables/index.gen.md @@ -1,15 +1,15 @@ -# local applications variables +# applications variables ## Overview Manage your local application's variables -**Aliases:** variables, variable, vars, var +**Aliases:** `variables`, `variable`, `vars`, `var` **Usage:** ``` -quix local applications variables [command] [options] +quix applications variables [command] [options] ``` **Commands:** diff --git a/docs/Reference/applications/library/index.md b/docs/Reference/applications/variables/index.md similarity index 100% rename from docs/Reference/applications/library/index.md rename to docs/Reference/applications/variables/index.md diff --git a/docs/Reference/local/applications/variables/list.gen.md b/docs/Reference/applications/variables/list.gen.md similarity index 62% rename from docs/Reference/local/applications/variables/list.gen.md rename to docs/Reference/applications/variables/list.gen.md index fe98bf9..2ee3e6e 100644 --- a/docs/Reference/local/applications/variables/list.gen.md +++ b/docs/Reference/applications/variables/list.gen.md @@ -1,15 +1,15 @@ -# local applications variables list +# applications variables list ## Overview Lists the variables of the current application -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** ``` -quix local applications variables list [options] +quix applications variables list [options] ``` **Options:** diff --git a/docs/Reference/local/applications/variables/list.md b/docs/Reference/applications/variables/list.md similarity index 87% rename from docs/Reference/local/applications/variables/list.md rename to docs/Reference/applications/variables/list.md index f406796..ffc07cb 100644 --- a/docs/Reference/local/applications/variables/list.md +++ b/docs/Reference/applications/variables/list.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local apps vars list` command lists all variables for a selected application. This command provides an overview of the current configuration variables in the `app.yaml` file. +The `quix apps vars list` command lists all variables for a selected application. This command provides an overview of the current configuration variables in the `app.yaml` file. When you run the command, you are prompted to select an application (if not already in an application directory). After selecting the application, the command retrieves and displays a table of all variables, including their names, default values, descriptions, types (Input Topic, Output Topic, Free Text, Secret), and whether they are required. @@ -14,7 +14,7 @@ When you run the command, you are prompted to select an application (if not alre When you execute the list local applications variable command without any options: ``` -$ quix local apps vars ls +$ quix apps vars ls ``` The interactive command starts. If your current directory is not an application directory, you are prompted to select the application for which you want to list the variables: diff --git a/docs/Reference/local/broker/index.gen.md b/docs/Reference/broker/index.gen.md similarity index 82% rename from docs/Reference/local/broker/index.gen.md rename to docs/Reference/broker/index.gen.md index f430ff6..7d0f0bf 100644 --- a/docs/Reference/local/broker/index.gen.md +++ b/docs/Reference/broker/index.gen.md @@ -1,4 +1,4 @@ -# local broker +# broker ## Overview @@ -9,7 +9,7 @@ Manage the local broker instance **Usage:** ``` -quix local broker [command] [options] +quix broker [command] [options] ``` **Commands:** diff --git a/docs/Reference/deployments/index.md b/docs/Reference/broker/index.md similarity index 100% rename from docs/Reference/deployments/index.md rename to docs/Reference/broker/index.md diff --git a/docs/Reference/applications/get.gen.md b/docs/Reference/cloud/applications/get.gen.md similarity index 70% rename from docs/Reference/applications/get.gen.md rename to docs/Reference/cloud/applications/get.gen.md index fde1042..c3e5255 100644 --- a/docs/Reference/applications/get.gen.md +++ b/docs/Reference/cloud/applications/get.gen.md @@ -1,23 +1,23 @@ -# applications get - -## Overview - -Get an application in the specified environment - -**Aliases:** get - -**Usage:** - -``` -quix applications get [ ] [options] -``` - -**Arguments:** - +# cloud applications get + +## Overview + +Get an application in the specified environment + +**Aliases:** `get` + +**Usage:** + +``` +quix cloud applications get [ ] [options] +``` + +**Arguments:** + - `` : The ID of the environment to set as default -- `` : The ID of the application - -**Options:** - -- `-o, --output ` : Output type of the retrieved data - +- `` : The ID of the application + +**Options:** + +- `-o, --output ` : Output type of the retrieved data + diff --git a/docs/Reference/applications/get.md b/docs/Reference/cloud/applications/get.md similarity index 100% rename from docs/Reference/applications/get.md rename to docs/Reference/cloud/applications/get.md diff --git a/docs/Reference/cloud/applications/index.gen.md b/docs/Reference/cloud/applications/index.gen.md new file mode 100644 index 0000000..8325cae --- /dev/null +++ b/docs/Reference/cloud/applications/index.gen.md @@ -0,0 +1,20 @@ +# cloud applications + +## Overview + +Manage the applications of an environment + +**Aliases:** `applications`, `application`, `apps`, `app` + +**Usage:** + +``` +quix cloud 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 + diff --git a/docs/Reference/environments/index.md b/docs/Reference/cloud/applications/index.md similarity index 100% rename from docs/Reference/environments/index.md rename to docs/Reference/cloud/applications/index.md diff --git a/docs/Reference/applications/library/index.gen.md b/docs/Reference/cloud/applications/library/index.gen.md similarity index 57% rename from docs/Reference/applications/library/index.gen.md rename to docs/Reference/cloud/applications/library/index.gen.md index b4e630d..c5b550b 100644 --- a/docs/Reference/applications/library/index.gen.md +++ b/docs/Reference/cloud/applications/library/index.gen.md @@ -1,15 +1,15 @@ -# applications library +# cloud applications library ## Overview Manage the library items of an environment -**Aliases:** library +**Aliases:** `library` **Usage:** ``` -quix applications library [command] [options] +quix cloud applications library [command] [options] ``` **Commands:** diff --git a/docs/Reference/local/applications/index.md b/docs/Reference/cloud/applications/library/index.md similarity index 100% rename from docs/Reference/local/applications/index.md rename to docs/Reference/cloud/applications/library/index.md diff --git a/docs/Reference/applications/library/list.gen.md b/docs/Reference/cloud/applications/library/list.gen.md similarity index 68% rename from docs/Reference/applications/library/list.gen.md rename to docs/Reference/cloud/applications/library/list.gen.md index 8404f92..e791a09 100644 --- a/docs/Reference/applications/library/list.gen.md +++ b/docs/Reference/cloud/applications/library/list.gen.md @@ -1,15 +1,15 @@ -# applications library list +# cloud applications library list ## Overview Get all library items -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** ``` -quix applications library list [options] +quix cloud applications library list [options] ``` **Options:** diff --git a/docs/Reference/cloud/applications/library/list.md b/docs/Reference/cloud/applications/library/list.md new file mode 100644 index 0000000..6b5f915 --- /dev/null +++ b/docs/Reference/cloud/applications/library/list.md @@ -0,0 +1 @@ +{% include-markdown './list.gen.md' %} diff --git a/docs/Reference/cloud/applications/list.gen.md b/docs/Reference/cloud/applications/list.gen.md new file mode 100644 index 0000000..def042b --- /dev/null +++ b/docs/Reference/cloud/applications/list.gen.md @@ -0,0 +1,22 @@ +# cloud applications list + +## Overview + +Get all applications in the specified environment + +**Aliases:** `list`, `ls` + +**Usage:** + +``` +quix cloud applications list [] [options] +``` + +**Arguments:** + +- `` : The ID of the environment + +**Options:** + +- `-o, --output ` : Output type of the retrieved data + diff --git a/docs/Reference/local/applications/list.md b/docs/Reference/cloud/applications/list.md similarity index 95% rename from docs/Reference/local/applications/list.md rename to docs/Reference/cloud/applications/list.md index 03f0983..ca335d4 100644 --- a/docs/Reference/local/applications/list.md +++ b/docs/Reference/cloud/applications/list.md @@ -5,7 +5,7 @@ When you enter the command without any options: ``` -$ quix local applications list +$ quix cloud applications list ``` A table containing all your local applications is printed: diff --git a/docs/Reference/deployments/get.gen.md b/docs/Reference/cloud/deployments/get.gen.md similarity index 80% rename from docs/Reference/deployments/get.gen.md rename to docs/Reference/cloud/deployments/get.gen.md index 127b236..8c5b3da 100644 --- a/docs/Reference/deployments/get.gen.md +++ b/docs/Reference/cloud/deployments/get.gen.md @@ -1,15 +1,15 @@ -# deployments get +# cloud deployments get ## Overview Get the details for a deployment -**Aliases:** get +**Aliases:** `get` **Usage:** ``` -quix deployments get [ []] [options] +quix cloud deployments get [ []] [options] ``` **Arguments:** diff --git a/docs/Reference/deployments/get.md b/docs/Reference/cloud/deployments/get.md similarity index 100% rename from docs/Reference/deployments/get.md rename to docs/Reference/cloud/deployments/get.md diff --git a/docs/Reference/deployments/index.gen.md b/docs/Reference/cloud/deployments/index.gen.md similarity index 79% rename from docs/Reference/deployments/index.gen.md rename to docs/Reference/cloud/deployments/index.gen.md index c7cba0f..e63ef3a 100644 --- a/docs/Reference/deployments/index.gen.md +++ b/docs/Reference/cloud/deployments/index.gen.md @@ -1,15 +1,15 @@ -# deployments +# cloud deployments ## Overview Manage the deployments of an environment -**Aliases:** deployments, deployment +**Aliases:** `deployments`, `deployment` **Usage:** ``` -quix deployments [command] [options] +quix cloud deployments [command] [options] ``` **Commands:** diff --git a/docs/Reference/local/applications/variables/index.md b/docs/Reference/cloud/deployments/index.md similarity index 100% rename from docs/Reference/local/applications/variables/index.md rename to docs/Reference/cloud/deployments/index.md diff --git a/docs/Reference/deployments/list.gen.md b/docs/Reference/cloud/deployments/list.gen.md similarity index 81% rename from docs/Reference/deployments/list.gen.md rename to docs/Reference/cloud/deployments/list.gen.md index 7ae7346..4ceb8e0 100644 --- a/docs/Reference/deployments/list.gen.md +++ b/docs/Reference/cloud/deployments/list.gen.md @@ -1,15 +1,15 @@ -# deployments list +# cloud deployments list ## Overview Get the information for all the deployments in an environment -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** ``` -quix deployments list [] [options] +quix cloud deployments list [] [options] ``` **Arguments:** diff --git a/docs/Reference/deployments/list.md b/docs/Reference/cloud/deployments/list.md similarity index 100% rename from docs/Reference/deployments/list.md rename to docs/Reference/cloud/deployments/list.md diff --git a/docs/Reference/deployments/logs.gen.md b/docs/Reference/cloud/deployments/logs.gen.md similarity index 77% rename from docs/Reference/deployments/logs.gen.md rename to docs/Reference/cloud/deployments/logs.gen.md index be66b2c..d032c17 100644 --- a/docs/Reference/deployments/logs.gen.md +++ b/docs/Reference/cloud/deployments/logs.gen.md @@ -1,15 +1,15 @@ -# deployments logs +# cloud deployments logs ## Overview Get deployments logs -**Aliases:** logs +**Aliases:** `logs` **Usage:** ``` -quix deployments logs [] [options] +quix cloud deployments logs [] [options] ``` **Arguments:** diff --git a/docs/Reference/deployments/logs.md b/docs/Reference/cloud/deployments/logs.md similarity index 100% rename from docs/Reference/deployments/logs.md rename to docs/Reference/cloud/deployments/logs.md diff --git a/docs/Reference/deployments/metrics.gen.md b/docs/Reference/cloud/deployments/metrics.gen.md similarity index 50% rename from docs/Reference/deployments/metrics.gen.md rename to docs/Reference/cloud/deployments/metrics.gen.md index 14f1086..6944395 100644 --- a/docs/Reference/deployments/metrics.gen.md +++ b/docs/Reference/cloud/deployments/metrics.gen.md @@ -1,15 +1,15 @@ -# deployments metrics +# cloud deployments metrics ## Overview Get deployments metrics -**Aliases:** metrics +**Aliases:** `metrics` **Usage:** ``` -quix deployments metrics [] [options] +quix cloud deployments metrics [] [options] ``` **Arguments:** diff --git a/docs/Reference/deployments/metrics.md b/docs/Reference/cloud/deployments/metrics.md similarity index 100% rename from docs/Reference/deployments/metrics.md rename to docs/Reference/cloud/deployments/metrics.md diff --git a/docs/Reference/deployments/start.gen.md b/docs/Reference/cloud/deployments/start.gen.md similarity index 51% rename from docs/Reference/deployments/start.gen.md rename to docs/Reference/cloud/deployments/start.gen.md index cda55ec..34659cf 100644 --- a/docs/Reference/deployments/start.gen.md +++ b/docs/Reference/cloud/deployments/start.gen.md @@ -1,15 +1,15 @@ -# deployments start +# cloud deployments start ## Overview Start a deployment -**Aliases:** start +**Aliases:** `start` **Usage:** ``` -quix deployments start [] [options] +quix cloud deployments start [] [options] ``` **Arguments:** diff --git a/docs/Reference/deployments/start.md b/docs/Reference/cloud/deployments/start.md similarity index 100% rename from docs/Reference/deployments/start.md rename to docs/Reference/cloud/deployments/start.md diff --git a/docs/Reference/deployments/stop.gen.md b/docs/Reference/cloud/deployments/stop.gen.md similarity index 51% rename from docs/Reference/deployments/stop.gen.md rename to docs/Reference/cloud/deployments/stop.gen.md index b26a213..deb2b12 100644 --- a/docs/Reference/deployments/stop.gen.md +++ b/docs/Reference/cloud/deployments/stop.gen.md @@ -1,15 +1,15 @@ -# deployments stop +# cloud deployments stop ## Overview Stop a deployment -**Aliases:** stop +**Aliases:** `stop` **Usage:** ``` -quix deployments stop [] [options] +quix cloud deployments stop [] [options] ``` **Arguments:** diff --git a/docs/Reference/deployments/stop.md b/docs/Reference/cloud/deployments/stop.md similarity index 100% rename from docs/Reference/deployments/stop.md rename to docs/Reference/cloud/deployments/stop.md diff --git a/docs/Reference/environments/get.gen.md b/docs/Reference/cloud/environments/get.gen.md similarity index 72% rename from docs/Reference/environments/get.gen.md rename to docs/Reference/cloud/environments/get.gen.md index dfb861d..0c0da6a 100644 --- a/docs/Reference/environments/get.gen.md +++ b/docs/Reference/cloud/environments/get.gen.md @@ -1,22 +1,22 @@ -# environments get - -## Overview - -Retrieves details of a specific environment accessible to the currently authenticated user - -**Aliases:** get - -**Usage:** - -``` -quix environments get [options] -``` - -**Arguments:** - -- `` : The ID of the environment - -**Options:** - -- `-o, --output ` : Output type of the retrieved data - +# cloud environments get + +## Overview + +Retrieves details of a specific environment accessible to the currently authenticated user + +**Aliases:** `get` + +**Usage:** + +``` +quix cloud environments get [options] +``` + +**Arguments:** + +- `` : The ID of the environment + +**Options:** + +- `-o, --output ` : Output type of the retrieved data + diff --git a/docs/Reference/environments/get.md b/docs/Reference/cloud/environments/get.md similarity index 100% rename from docs/Reference/environments/get.md rename to docs/Reference/cloud/environments/get.md diff --git a/docs/Reference/environments/index.gen.md b/docs/Reference/cloud/environments/index.gen.md similarity index 62% rename from docs/Reference/environments/index.gen.md rename to docs/Reference/cloud/environments/index.gen.md index 7383e3b..8936023 100644 --- a/docs/Reference/environments/index.gen.md +++ b/docs/Reference/cloud/environments/index.gen.md @@ -1,15 +1,15 @@ -# environments +# cloud environments ## Overview -Manage the environments +Manage the environments of your projects (e.g., Dev, Staging, Production) -**Aliases:** environments, environment, envs, env, workspaces, workspace +**Aliases:** `environments`, `environment`, `envs`, `env`, `workspaces`, `workspace` **Usage:** ``` -quix environments [command] [options] +quix cloud environments [command] [options] ``` **Commands:** diff --git a/docs/Reference/local/broker/index.md b/docs/Reference/cloud/environments/index.md similarity index 100% rename from docs/Reference/local/broker/index.md rename to docs/Reference/cloud/environments/index.md diff --git a/docs/Reference/environments/list.gen.md b/docs/Reference/cloud/environments/list.gen.md similarity index 65% rename from docs/Reference/environments/list.gen.md rename to docs/Reference/cloud/environments/list.gen.md index 5761390..99582fe 100644 --- a/docs/Reference/environments/list.gen.md +++ b/docs/Reference/cloud/environments/list.gen.md @@ -1,15 +1,15 @@ -# environments list +# cloud environments list ## Overview List all environments the current user has access to -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** ``` -quix environments list [options] +quix cloud environments list [options] ``` **Options:** diff --git a/docs/Reference/environments/list.md b/docs/Reference/cloud/environments/list.md similarity index 100% rename from docs/Reference/environments/list.md rename to docs/Reference/cloud/environments/list.md diff --git a/docs/Reference/environments/sync.gen.md b/docs/Reference/cloud/environments/sync.gen.md similarity index 76% rename from docs/Reference/environments/sync.gen.md rename to docs/Reference/cloud/environments/sync.gen.md index 7c64838..64d0f84 100644 --- a/docs/Reference/environments/sync.gen.md +++ b/docs/Reference/cloud/environments/sync.gen.md @@ -1,15 +1,15 @@ -# environments sync +# cloud environments sync ## Overview Sync your environment based on the attached project -**Aliases:** sync, deploy +**Aliases:** `sync`, `deploy` **Usage:** ``` -quix environments sync [] [options] +quix cloud environments sync [] [options] ``` **Arguments:** diff --git a/docs/Reference/environments/sync.md b/docs/Reference/cloud/environments/sync.md similarity index 100% rename from docs/Reference/environments/sync.md rename to docs/Reference/cloud/environments/sync.md diff --git a/docs/Reference/environments/use.gen.md b/docs/Reference/cloud/environments/use.gen.md similarity index 62% rename from docs/Reference/environments/use.gen.md rename to docs/Reference/cloud/environments/use.gen.md index b84543a..a38c607 100644 --- a/docs/Reference/environments/use.gen.md +++ b/docs/Reference/cloud/environments/use.gen.md @@ -1,18 +1,18 @@ -# environments use - -## Overview - -Select the default environment for the current context - -**Aliases:** use - -**Usage:** - -``` -quix environments use [] [options] -``` - -**Arguments:** - -- `` : The ID of the environment to set as default - +# cloud environments use + +## Overview + +Select the default environment for the current context + +**Aliases:** `use` + +**Usage:** + +``` +quix cloud environments use [] [options] +``` + +**Arguments:** + +- `` : The ID of the environment to set as default + diff --git a/docs/Reference/cloud/environments/use.md b/docs/Reference/cloud/environments/use.md new file mode 100644 index 0000000..3d6325d --- /dev/null +++ b/docs/Reference/cloud/environments/use.md @@ -0,0 +1,5 @@ +{% include-markdown './use.gen.md' %} +!!! info + + Used as an Alias for [this](../../use.md) command + diff --git a/docs/Reference/cloud/index.gen.md b/docs/Reference/cloud/index.gen.md new file mode 100644 index 0000000..9b2ea64 --- /dev/null +++ b/docs/Reference/cloud/index.gen.md @@ -0,0 +1,24 @@ +# cloud + +## Overview + +Performs cloud related operations + +**Aliases:** `cloud`, `remote` + +**Usage:** + +``` +quix cloud [command] [options] +``` + +**Commands:** + +- [organisations](organisations\index.md) : Manage your organisation +- [projects](projects\index.md) : Manage the projects of the current organisation +- [environments](environments\index.md) : Manage the environments of your projects (e.g., Dev, Staging, Production) +- [applications](applications\index.md) : Manage the applications of an environment +- [deployments](deployments\index.md) : Manage the deployments of an environment +- [topics](topics\index.md) : Manage the topics of an environment +- [users](users\index.md) : Manage the users of the organisation including audit, permissions and tokens + diff --git a/docs/Reference/local/index.md b/docs/Reference/cloud/index.md similarity index 100% rename from docs/Reference/local/index.md rename to docs/Reference/cloud/index.md diff --git a/docs/Reference/organisations/get.gen.md b/docs/Reference/cloud/organisations/get.gen.md similarity index 69% rename from docs/Reference/organisations/get.gen.md rename to docs/Reference/cloud/organisations/get.gen.md index b6d98e8..9581aa0 100644 --- a/docs/Reference/organisations/get.gen.md +++ b/docs/Reference/cloud/organisations/get.gen.md @@ -1,15 +1,15 @@ -# organisations get +# cloud organisations get ## Overview Gets the organisation details the currently authenticated user belongs to -**Aliases:** get +**Aliases:** `get` **Usage:** ``` -quix organisations get [options] +quix cloud organisations get [options] ``` **Options:** diff --git a/docs/Reference/local/pipeline/deployments/get.md b/docs/Reference/cloud/organisations/get.md similarity index 100% rename from docs/Reference/local/pipeline/deployments/get.md rename to docs/Reference/cloud/organisations/get.md diff --git a/docs/Reference/organisations/index.gen.md b/docs/Reference/cloud/organisations/index.gen.md similarity index 51% rename from docs/Reference/organisations/index.gen.md rename to docs/Reference/cloud/organisations/index.gen.md index 355fdab..b8830db 100644 --- a/docs/Reference/organisations/index.gen.md +++ b/docs/Reference/cloud/organisations/index.gen.md @@ -1,15 +1,15 @@ -# organisations +# cloud organisations ## Overview Manage your organisation -**Aliases:** organisations, organisation, organizations, organization, orgs, org +**Aliases:** `organisations`, `organisation`, `organizations`, `organization`, `orgs`, `org` **Usage:** ``` -quix organisations [command] [options] +quix cloud organisations [command] [options] ``` **Commands:** diff --git a/docs/Reference/local/pipeline/deployments/index.md b/docs/Reference/cloud/organisations/index.md similarity index 100% rename from docs/Reference/local/pipeline/deployments/index.md rename to docs/Reference/cloud/organisations/index.md diff --git a/docs/Reference/projects/get.gen.md b/docs/Reference/cloud/projects/get.gen.md similarity index 71% rename from docs/Reference/projects/get.gen.md rename to docs/Reference/cloud/projects/get.gen.md index 5872667..243c386 100644 --- a/docs/Reference/projects/get.gen.md +++ b/docs/Reference/cloud/projects/get.gen.md @@ -1,15 +1,15 @@ -# projects get +# cloud projects get ## Overview Get all projects of the current organisation -**Aliases:** get +**Aliases:** `get` **Usage:** ``` -quix projects get [options] +quix cloud projects get [options] ``` **Arguments:** diff --git a/docs/Reference/organisations/get.md b/docs/Reference/cloud/projects/get.md similarity index 100% rename from docs/Reference/organisations/get.md rename to docs/Reference/cloud/projects/get.md diff --git a/docs/Reference/projects/index.gen.md b/docs/Reference/cloud/projects/index.gen.md similarity index 67% rename from docs/Reference/projects/index.gen.md rename to docs/Reference/cloud/projects/index.gen.md index 057fa04..a910362 100644 --- a/docs/Reference/projects/index.gen.md +++ b/docs/Reference/cloud/projects/index.gen.md @@ -1,15 +1,15 @@ -# projects +# cloud projects ## Overview Manage the projects of the current organisation -**Aliases:** projects, project, repositories, repository, repos, repo +**Aliases:** `projects`, `project`, `repositories`, `repository`, `repos`, `repo` **Usage:** ``` -quix projects [command] [options] +quix cloud projects [command] [options] ``` **Commands:** diff --git a/docs/Reference/local/pipeline/index.md b/docs/Reference/cloud/projects/index.md similarity index 100% rename from docs/Reference/local/pipeline/index.md rename to docs/Reference/cloud/projects/index.md diff --git a/docs/Reference/projects/list.gen.md b/docs/Reference/cloud/projects/list.gen.md similarity index 66% rename from docs/Reference/projects/list.gen.md rename to docs/Reference/cloud/projects/list.gen.md index d390dcb..dce9ff9 100644 --- a/docs/Reference/projects/list.gen.md +++ b/docs/Reference/cloud/projects/list.gen.md @@ -1,15 +1,15 @@ -# projects list +# cloud projects list ## Overview Get all projects of the current organisation -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** ``` -quix projects list [options] +quix cloud projects list [options] ``` **Options:** diff --git a/docs/Reference/local/pipeline/deployments/list.md b/docs/Reference/cloud/projects/list.md similarity index 100% rename from docs/Reference/local/pipeline/deployments/list.md rename to docs/Reference/cloud/projects/list.md diff --git a/docs/Reference/projects/patch.gen.md b/docs/Reference/cloud/projects/patch.gen.md similarity index 87% rename from docs/Reference/projects/patch.gen.md rename to docs/Reference/cloud/projects/patch.gen.md index b12dd5c..172354d 100644 --- a/docs/Reference/projects/patch.gen.md +++ b/docs/Reference/cloud/projects/patch.gen.md @@ -1,15 +1,15 @@ -# projects patch +# cloud projects patch ## Overview Edit individual properties of a project -**Aliases:** patch +**Aliases:** `patch` **Usage:** ``` -quix projects patch [options] +quix cloud projects patch [options] ``` **Arguments:** diff --git a/docs/Reference/projects/patch.md b/docs/Reference/cloud/projects/patch.md similarity index 100% rename from docs/Reference/projects/patch.md rename to docs/Reference/cloud/projects/patch.md diff --git a/docs/Reference/topics/get.gen.md b/docs/Reference/cloud/topics/get.gen.md similarity index 69% rename from docs/Reference/topics/get.gen.md rename to docs/Reference/cloud/topics/get.gen.md index 268311c..cc16a0d 100644 --- a/docs/Reference/topics/get.gen.md +++ b/docs/Reference/cloud/topics/get.gen.md @@ -1,15 +1,15 @@ -# topics get +# cloud topics get ## Overview Get information of a topic for the specified environment -**Aliases:** get +**Aliases:** `get` **Usage:** ``` -quix topics get [] [options] +quix cloud topics get [] [options] ``` **Arguments:** diff --git a/docs/Reference/projects/get.md b/docs/Reference/cloud/topics/get.md similarity index 100% rename from docs/Reference/projects/get.md rename to docs/Reference/cloud/topics/get.md diff --git a/docs/Reference/topics/index.gen.md b/docs/Reference/cloud/topics/index.gen.md similarity index 74% rename from docs/Reference/topics/index.gen.md rename to docs/Reference/cloud/topics/index.gen.md index eba428b..fc52429 100644 --- a/docs/Reference/topics/index.gen.md +++ b/docs/Reference/cloud/topics/index.gen.md @@ -1,15 +1,15 @@ -# topics +# cloud topics ## Overview Manage the topics of an environment -**Aliases:** topics, topic +**Aliases:** `topics`, `topic` **Usage:** ``` -quix topics [command] [options] +quix cloud topics [command] [options] ``` **Commands:** diff --git a/docs/Reference/organisations/index.md b/docs/Reference/cloud/topics/index.md similarity index 100% rename from docs/Reference/organisations/index.md rename to docs/Reference/cloud/topics/index.md diff --git a/docs/Reference/topics/list.gen.md b/docs/Reference/cloud/topics/list.gen.md similarity index 68% rename from docs/Reference/topics/list.gen.md rename to docs/Reference/cloud/topics/list.gen.md index 94d1470..9b75a47 100644 --- a/docs/Reference/topics/list.gen.md +++ b/docs/Reference/cloud/topics/list.gen.md @@ -1,15 +1,15 @@ -# topics list +# cloud topics list ## Overview Get all topics information for the specified environment -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** ``` -quix topics list [] [options] +quix cloud topics list [] [options] ``` **Arguments:** diff --git a/docs/Reference/projects/list.md b/docs/Reference/cloud/topics/list.md similarity index 100% rename from docs/Reference/projects/list.md rename to docs/Reference/cloud/topics/list.md diff --git a/docs/Reference/users/audit.gen.md b/docs/Reference/cloud/users/audit.gen.md similarity index 92% rename from docs/Reference/users/audit.gen.md rename to docs/Reference/cloud/users/audit.gen.md index d655e45..67a2c0f 100644 --- a/docs/Reference/users/audit.gen.md +++ b/docs/Reference/cloud/users/audit.gen.md @@ -1,15 +1,15 @@ -# users audit +# cloud users audit ## Overview Get the auditing details of the users of your organization -**Aliases:** audit +**Aliases:** `audit` **Usage:** ``` -quix users audit [ []] [options] +quix cloud users audit [ []] [options] ``` **Arguments:** diff --git a/docs/Reference/users/audit.md b/docs/Reference/cloud/users/audit.md similarity index 100% rename from docs/Reference/users/audit.md rename to docs/Reference/cloud/users/audit.md diff --git a/docs/Reference/users/current.gen.md b/docs/Reference/cloud/users/current.gen.md similarity index 68% rename from docs/Reference/users/current.gen.md rename to docs/Reference/cloud/users/current.gen.md index 2ef9329..01a1a7a 100644 --- a/docs/Reference/users/current.gen.md +++ b/docs/Reference/cloud/users/current.gen.md @@ -1,15 +1,15 @@ -# users current +# cloud users current ## Overview Gets the details of the currently-authenticated user -**Aliases:** current +**Aliases:** `current` **Usage:** ``` -quix users current [options] +quix cloud users current [options] ``` **Options:** diff --git a/docs/Reference/users/current.md b/docs/Reference/cloud/users/current.md similarity index 100% rename from docs/Reference/users/current.md rename to docs/Reference/cloud/users/current.md diff --git a/docs/Reference/users/index.gen.md b/docs/Reference/cloud/users/index.gen.md similarity index 72% rename from docs/Reference/users/index.gen.md rename to docs/Reference/cloud/users/index.gen.md index ac8d6e5..39257ac 100644 --- a/docs/Reference/users/index.gen.md +++ b/docs/Reference/cloud/users/index.gen.md @@ -1,15 +1,15 @@ -# users +# cloud users ## Overview -Manage the users of the current organisation +Manage the users of the organisation including audit, permissions and tokens -**Aliases:** users, user +**Aliases:** `users`, `user` **Usage:** ``` -quix users [command] [options] +quix cloud users [command] [options] ``` **Commands:** diff --git a/docs/Reference/projects/index.md b/docs/Reference/cloud/users/index.md similarity index 100% rename from docs/Reference/projects/index.md rename to docs/Reference/cloud/users/index.md diff --git a/docs/Reference/users/list.gen.md b/docs/Reference/cloud/users/list.gen.md similarity index 66% rename from docs/Reference/users/list.gen.md rename to docs/Reference/cloud/users/list.gen.md index d6f4516..208cde6 100644 --- a/docs/Reference/users/list.gen.md +++ b/docs/Reference/cloud/users/list.gen.md @@ -1,15 +1,15 @@ -# users list +# cloud users list ## Overview List all users in the organisation -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** ``` -quix users list [options] +quix cloud users list [options] ``` **Options:** diff --git a/docs/Reference/topics/list.md b/docs/Reference/cloud/users/list.md similarity index 100% rename from docs/Reference/topics/list.md rename to docs/Reference/cloud/users/list.md diff --git a/docs/Reference/users/permissions/copy.gen.md b/docs/Reference/cloud/users/permissions/copy.gen.md similarity index 64% rename from docs/Reference/users/permissions/copy.gen.md rename to docs/Reference/cloud/users/permissions/copy.gen.md index 1e8f15b..f42be03 100644 --- a/docs/Reference/users/permissions/copy.gen.md +++ b/docs/Reference/cloud/users/permissions/copy.gen.md @@ -1,15 +1,15 @@ -# users permissions copy +# cloud users permissions copy ## Overview Copy the user permissions from a user to other users -**Aliases:** copy +**Aliases:** `copy` **Usage:** ``` -quix users permissions copy [] [options] +quix cloud users permissions copy [] [options] ``` **Arguments:** diff --git a/docs/Reference/users/permissions/copy.md b/docs/Reference/cloud/users/permissions/copy.md similarity index 100% rename from docs/Reference/users/permissions/copy.md rename to docs/Reference/cloud/users/permissions/copy.md diff --git a/docs/Reference/users/permissions/delete.gen.md b/docs/Reference/cloud/users/permissions/delete.gen.md similarity index 63% rename from docs/Reference/users/permissions/delete.gen.md rename to docs/Reference/cloud/users/permissions/delete.gen.md index 39631d3..504233d 100644 --- a/docs/Reference/users/permissions/delete.gen.md +++ b/docs/Reference/cloud/users/permissions/delete.gen.md @@ -1,15 +1,15 @@ -# users permissions delete +# cloud users permissions delete ## Overview Deletes the value of a single permission of a user in the organisation -**Aliases:** delete, del, remove, rm +**Aliases:** `delete`, `del`, `remove`, `rm` **Usage:** ``` -quix users permissions delete [] [options] +quix cloud users permissions delete [] [options] ``` **Arguments:** diff --git a/docs/Reference/users/permissions/delete.md b/docs/Reference/cloud/users/permissions/delete.md similarity index 100% rename from docs/Reference/users/permissions/delete.md rename to docs/Reference/cloud/users/permissions/delete.md diff --git a/docs/Reference/users/permissions/edit.gen.md b/docs/Reference/cloud/users/permissions/edit.gen.md similarity index 77% rename from docs/Reference/users/permissions/edit.gen.md rename to docs/Reference/cloud/users/permissions/edit.gen.md index f9bf9e8..41928ef 100644 --- a/docs/Reference/users/permissions/edit.gen.md +++ b/docs/Reference/cloud/users/permissions/edit.gen.md @@ -1,15 +1,15 @@ -# users permissions edit +# cloud users permissions edit ## Overview Adds or edits the value of a single permission of a user in the organisation. Available roles: [Admin, Manager, Editor, Viewer] -**Aliases:** edit +**Aliases:** `edit` **Usage:** ``` -quix users permissions edit [] [options] +quix cloud users permissions edit [] [options] ``` **Arguments:** diff --git a/docs/Reference/users/permissions/edit.md b/docs/Reference/cloud/users/permissions/edit.md similarity index 100% rename from docs/Reference/users/permissions/edit.md rename to docs/Reference/cloud/users/permissions/edit.md diff --git a/docs/Reference/users/permissions/get.gen.md b/docs/Reference/cloud/users/permissions/get.gen.md similarity index 76% rename from docs/Reference/users/permissions/get.gen.md rename to docs/Reference/cloud/users/permissions/get.gen.md index 16b9ae8..e73e8e4 100644 --- a/docs/Reference/users/permissions/get.gen.md +++ b/docs/Reference/cloud/users/permissions/get.gen.md @@ -1,15 +1,15 @@ -# users permissions get +# cloud users permissions get ## Overview Get the permissions of a user or all the users in the organisation -**Aliases:** get +**Aliases:** `get` **Usage:** ``` -quix users permissions get [] [options] +quix cloud users permissions get [] [options] ``` **Arguments:** diff --git a/docs/Reference/users/permissions/get.md b/docs/Reference/cloud/users/permissions/get.md similarity index 100% rename from docs/Reference/users/permissions/get.md rename to docs/Reference/cloud/users/permissions/get.md diff --git a/docs/Reference/users/permissions/index.gen.md b/docs/Reference/cloud/users/permissions/index.gen.md similarity index 85% rename from docs/Reference/users/permissions/index.gen.md rename to docs/Reference/cloud/users/permissions/index.gen.md index a80ef95..5d49287 100644 --- a/docs/Reference/users/permissions/index.gen.md +++ b/docs/Reference/cloud/users/permissions/index.gen.md @@ -1,15 +1,15 @@ -# users permissions +# cloud users permissions ## Overview Manage the user permissions -**Aliases:** permissions, permission +**Aliases:** `permissions`, `permission` **Usage:** ``` -quix users permissions [command] [options] +quix cloud users permissions [command] [options] ``` **Commands:** diff --git a/docs/Reference/topics/index.md b/docs/Reference/cloud/users/permissions/index.md similarity index 100% rename from docs/Reference/topics/index.md rename to docs/Reference/cloud/users/permissions/index.md diff --git a/docs/Reference/users/permissions/list.gen.md b/docs/Reference/cloud/users/permissions/list.gen.md similarity index 63% rename from docs/Reference/users/permissions/list.gen.md rename to docs/Reference/cloud/users/permissions/list.gen.md index 89f8bba..6cba687 100644 --- a/docs/Reference/users/permissions/list.gen.md +++ b/docs/Reference/cloud/users/permissions/list.gen.md @@ -1,15 +1,15 @@ -# users permissions list +# cloud users permissions list ## Overview Get the permissions of all the users in the organisation -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** ``` -quix users permissions list [options] +quix cloud users permissions list [options] ``` **Options:** diff --git a/docs/Reference/users/permissions/list.md b/docs/Reference/cloud/users/permissions/list.md similarity index 100% rename from docs/Reference/users/permissions/list.md rename to docs/Reference/cloud/users/permissions/list.md diff --git a/docs/Reference/users/permissions/set.gen.md b/docs/Reference/cloud/users/permissions/set.gen.md similarity index 75% rename from docs/Reference/users/permissions/set.gen.md rename to docs/Reference/cloud/users/permissions/set.gen.md index a386919..a1efe92 100644 --- a/docs/Reference/users/permissions/set.gen.md +++ b/docs/Reference/cloud/users/permissions/set.gen.md @@ -1,15 +1,15 @@ -# users permissions set +# cloud users permissions set ## Overview Sets the whole permissions of a user, replacing the current ones. Available roles: [Admin, Manager, Editor, Viewer] -**Aliases:** set +**Aliases:** `set` **Usage:** ``` -quix users permissions set [] [options] +quix cloud users permissions set [] [options] ``` **Arguments:** diff --git a/docs/Reference/users/permissions/set.md b/docs/Reference/cloud/users/permissions/set.md similarity index 100% rename from docs/Reference/users/permissions/set.md rename to docs/Reference/cloud/users/permissions/set.md diff --git a/docs/Reference/users/tokens/create.gen.md b/docs/Reference/cloud/users/tokens/create.gen.md similarity index 79% rename from docs/Reference/users/tokens/create.gen.md rename to docs/Reference/cloud/users/tokens/create.gen.md index 182dbfb..cd6a901 100644 --- a/docs/Reference/users/tokens/create.gen.md +++ b/docs/Reference/cloud/users/tokens/create.gen.md @@ -1,24 +1,24 @@ -# users tokens create - -## Overview - -Creates a new personal access token - -**Aliases:** create, add - -**Usage:** - -``` -quix users tokens create [options] -``` - -**Arguments:** - -- `` : A name that describes the new token - -**Options:** - +# cloud users tokens create + +## Overview + +Creates a new personal access token + +**Aliases:** `create`, `add` + +**Usage:** + +``` +quix cloud users tokens create [options] +``` + +**Arguments:** + +- `` : A name that describes the new token + +**Options:** + - `-o, --output ` : Output type of the retrieved data -- `--expires-at ` : Define when the token will expire. Supports ISO 8601 dates: 'YYYY-MM-DD HH:MM:SS.sss'. All times UTC. [default: 2025-06-13] -- `-p, --permission-assignments (REQUIRED)` : Array of permission assignments in the format "[{Scope, Permission, Permission, ..}, {Scope, Permission, Permission, ..}, ...]" - +- `--expires-at ` : Define when the token will expire. Supports ISO 8601 dates: 'YYYY-MM-DD HH:MM:SS.sss'. All times UTC. [default: 2025-06-21] +- `-p, --permission-assignments (REQUIRED)` : Array of permission assignments in the format "[{Scope, Permission, Permission, ..}, {Scope, Permission, Permission, ..}, ...]" + diff --git a/docs/Reference/local/pipeline/deployments/create.md b/docs/Reference/cloud/users/tokens/create.md similarity index 100% rename from docs/Reference/local/pipeline/deployments/create.md rename to docs/Reference/cloud/users/tokens/create.md diff --git a/docs/Reference/users/tokens/edit.gen.md b/docs/Reference/cloud/users/tokens/edit.gen.md similarity index 86% rename from docs/Reference/users/tokens/edit.gen.md rename to docs/Reference/cloud/users/tokens/edit.gen.md index f2f175f..2fcaa1a 100644 --- a/docs/Reference/users/tokens/edit.gen.md +++ b/docs/Reference/cloud/users/tokens/edit.gen.md @@ -1,15 +1,15 @@ -# users tokens edit +# cloud users tokens edit ## Overview Edits an existing personal access token -**Aliases:** edit +**Aliases:** `edit` **Usage:** ``` -quix users tokens edit [options] +quix cloud users tokens edit [options] ``` **Arguments:** diff --git a/docs/Reference/local/pipeline/deployments/edit.md b/docs/Reference/cloud/users/tokens/edit.md similarity index 100% rename from docs/Reference/local/pipeline/deployments/edit.md rename to docs/Reference/cloud/users/tokens/edit.md diff --git a/docs/Reference/users/tokens/index.gen.md b/docs/Reference/cloud/users/tokens/index.gen.md similarity index 79% rename from docs/Reference/users/tokens/index.gen.md rename to docs/Reference/cloud/users/tokens/index.gen.md index 72be8e4..8e21de9 100644 --- a/docs/Reference/users/tokens/index.gen.md +++ b/docs/Reference/cloud/users/tokens/index.gen.md @@ -1,15 +1,15 @@ -# users tokens +# cloud users tokens ## Overview Manage the personal access tokens of the current user -**Aliases:** tokens, token +**Aliases:** `tokens`, `token` **Usage:** ``` -quix users tokens [command] [options] +quix cloud users tokens [command] [options] ``` **Commands:** diff --git a/docs/Reference/users/index.md b/docs/Reference/cloud/users/tokens/index.md similarity index 100% rename from docs/Reference/users/index.md rename to docs/Reference/cloud/users/tokens/index.md diff --git a/docs/Reference/users/tokens/list.gen.md b/docs/Reference/cloud/users/tokens/list.gen.md similarity index 65% rename from docs/Reference/users/tokens/list.gen.md rename to docs/Reference/cloud/users/tokens/list.gen.md index 71cd782..34d4653 100644 --- a/docs/Reference/users/tokens/list.gen.md +++ b/docs/Reference/cloud/users/tokens/list.gen.md @@ -1,15 +1,15 @@ -# users tokens list +# cloud users tokens list ## Overview Gets all the personal access tokens of the current user -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** ``` -quix users tokens list [options] +quix cloud users tokens list [options] ``` **Options:** diff --git a/docs/Reference/users/list.md b/docs/Reference/cloud/users/tokens/list.md similarity index 100% rename from docs/Reference/users/list.md rename to docs/Reference/cloud/users/tokens/list.md diff --git a/docs/Reference/users/tokens/revoke.gen.md b/docs/Reference/cloud/users/tokens/revoke.gen.md similarity index 69% rename from docs/Reference/users/tokens/revoke.gen.md rename to docs/Reference/cloud/users/tokens/revoke.gen.md index 218b576..90bde79 100644 --- a/docs/Reference/users/tokens/revoke.gen.md +++ b/docs/Reference/cloud/users/tokens/revoke.gen.md @@ -1,15 +1,15 @@ -# users tokens revoke +# cloud users tokens revoke ## Overview Revokes an existing personal access token -**Aliases:** revoke +**Aliases:** `revoke` **Usage:** ``` -quix users tokens revoke [options] +quix cloud users tokens revoke [options] ``` **Arguments:** diff --git a/docs/Reference/users/tokens/revoke.md b/docs/Reference/cloud/users/tokens/revoke.md similarity index 100% rename from docs/Reference/users/tokens/revoke.md rename to docs/Reference/cloud/users/tokens/revoke.md diff --git a/docs/Reference/utils/note-output.md b/docs/Reference/cloud/utils/note-output.md similarity index 100% rename from docs/Reference/utils/note-output.md rename to docs/Reference/cloud/utils/note-output.md diff --git a/docs/Reference/utils/tip-use.md b/docs/Reference/cloud/utils/tip-use.md similarity index 100% rename from docs/Reference/utils/tip-use.md rename to docs/Reference/cloud/utils/tip-use.md diff --git a/docs/Reference/contexts/broker/cloud.gen.md b/docs/Reference/contexts/broker/cloud.gen.md index 29d512c..cca9b09 100644 --- a/docs/Reference/contexts/broker/cloud.gen.md +++ b/docs/Reference/contexts/broker/cloud.gen.md @@ -2,9 +2,9 @@ ## Overview -Set the local debug broker to the one in your Quix Cloud environment +Set the Sdk broker configuration to point to a 'Quix Cloud' broker -**Aliases:** cloud, disable +**Aliases:** `cloud`, `disable` **Usage:** @@ -12,3 +12,10 @@ Set the local debug broker to the one in your Quix Cloud environment quix contexts broker cloud [options] ``` +**Options:** + +- `--workspace-id ` : The environment to use if your Sdk broker configuration is set to Quix Cloud +- `--env-file-name ` : Set the name of the environment file [default: .env] +- `--directory ` : Base directory (defaults to current directory) +- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration + diff --git a/docs/Reference/contexts/broker/index.gen.md b/docs/Reference/contexts/broker/index.gen.md index 22eeb0f..e65cae2 100644 --- a/docs/Reference/contexts/broker/index.gen.md +++ b/docs/Reference/contexts/broker/index.gen.md @@ -2,9 +2,9 @@ ## Overview -Manage the local debug broker configuration of the current context +Manage the Sdk broker configuration that is injected to QuixStreams while developing locally -**Aliases:** broker +**Aliases:** `broker` **Usage:** @@ -14,7 +14,7 @@ quix contexts broker [command] [options] **Commands:** -- [cloud](cloud.md) : Set the local debug broker to the one in your Quix Cloud environment -- [local](local.md) : Sets the local debug broker to one accessible from your local machine (default: pipeline broker) -- [set](set.md) : Sets the address for the local debug broker of the current context +- [cloud](cloud.md) : Set the Sdk broker configuration to point to a 'Quix Cloud' broker +- [local](local.md) : Set the Sdk broker configuration to point to a 'Local' broker (default: pipeline broker) +- [set](set.md) : Set a local broker address for the Sdk broker configuration diff --git a/docs/Reference/contexts/broker/local.gen.md b/docs/Reference/contexts/broker/local.gen.md index be9ed83..90112ea 100644 --- a/docs/Reference/contexts/broker/local.gen.md +++ b/docs/Reference/contexts/broker/local.gen.md @@ -2,9 +2,9 @@ ## Overview -Sets the local debug broker to one accessible from your local machine (default: pipeline broker) +Set the Sdk broker configuration to point to a 'Local' broker (default: pipeline broker) -**Aliases:** local, enable +**Aliases:** `local`, `enable` **Usage:** @@ -12,3 +12,9 @@ Sets the local debug broker to one accessible from your local machine (default: quix contexts broker local [options] ``` +**Options:** + +- `--env-file-name ` : Set the name of the environment file [default: .env] +- `--directory ` : Base directory (defaults to current directory) +- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration + diff --git a/docs/Reference/contexts/broker/set.gen.md b/docs/Reference/contexts/broker/set.gen.md index c49ca27..98aafc7 100644 --- a/docs/Reference/contexts/broker/set.gen.md +++ b/docs/Reference/contexts/broker/set.gen.md @@ -2,9 +2,9 @@ ## Overview -Sets the address for the local debug broker of the current context +Set a local broker address for the Sdk broker configuration -**Aliases:** set +**Aliases:** `set` **Usage:** @@ -14,9 +14,13 @@ quix contexts broker set [
] [options] **Arguments:** -- `
` : The address for the local debug broker (ie: localhost:19092) +- `
` : The broker address for the Sdk broker configuration (ie: localhost:19092) **Options:** -- `--enable` : Enables the use of this local debug broker +- `--enable` : Enables Local broker as Sdk broker configuration +- `--workspace-id ` : The environment to use if your Sdk broker configuration is set to Quix Cloud +- `--env-file-name ` : Set the name of the environment file [default: .env] +- `--directory ` : Base directory (defaults to current directory) +- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration [] diff --git a/docs/Reference/contexts/broker/set.md b/docs/Reference/contexts/broker/set.md index 770e9ad..831530f 100644 --- a/docs/Reference/contexts/broker/set.md +++ b/docs/Reference/contexts/broker/set.md @@ -2,7 +2,7 @@ ## How It Works -The `quix contexts broker set` command allows you to specify the address for the local debug broker for the current context. By default, this sets the broker to `localhost:19092`, which is the default pipeline broker address that can be started with the [`quix local broker up`](../../local/broker/up.md) command. +The `quix contexts broker set` command allows you to specify the address for the local debug broker for the current context. By default, this sets the broker to `localhost:19092`, which is the default pipeline broker address that can be started with the [`quix broker up`](../../broker/up.md) command. However, using this default broker address is not required. You can change it to suit your development setup. For instance, if you already have a Kafka broker running locally, you might set the address to `localhost:9092`. Alternatively, you can set it to any other Kafka broker address, such as `kafka.example.com:9092`. diff --git a/docs/Reference/contexts/create.gen.md b/docs/Reference/contexts/create.gen.md index f0dfb3b..a6c67a3 100644 --- a/docs/Reference/contexts/create.gen.md +++ b/docs/Reference/contexts/create.gen.md @@ -4,7 +4,7 @@ Add a new context to the CLI -**Aliases:** create, add +**Aliases:** `create`, `add` **Usage:** @@ -19,7 +19,7 @@ quix contexts create [] [options] **Options:** - `-e, --endpoint ` : Portal endpoint -- `-b, --debug-broker-address ` : Local debug broker address -- `-c, --use-quix-cloud-broker` : Set the local debug broker to the one in your Quix Cloud environment -- `-l, --use-local-broker` : Set the local debug broker to one accessible from your local machine +- `-b, --sdk-broker-address ` : Sdk broker configuration address +- `-c, --use-quix-cloud-broker` : Set the Sdk broker configuration to the one in your Quix Cloud environment +- `-l, --use-local-broker` : Set the Sdk broker configuration to one accessible from your local machine diff --git a/docs/Reference/contexts/current.gen.md b/docs/Reference/contexts/current.gen.md index e722b75..c60978f 100644 --- a/docs/Reference/contexts/current.gen.md +++ b/docs/Reference/contexts/current.gen.md @@ -4,7 +4,7 @@ Gets information about the current context -**Aliases:** current +**Aliases:** `current` **Usage:** diff --git a/docs/Reference/contexts/delete.gen.md b/docs/Reference/contexts/delete.gen.md index 968d2c8..a673b09 100644 --- a/docs/Reference/contexts/delete.gen.md +++ b/docs/Reference/contexts/delete.gen.md @@ -4,7 +4,7 @@ Remove a context from the CLI -**Aliases:** delete, del, remove, rm +**Aliases:** `delete`, `del`, `remove`, `rm` **Usage:** diff --git a/docs/Reference/contexts/environments/clear.gen.md b/docs/Reference/contexts/environments/clear.gen.md index 0401ccc..34a9756 100644 --- a/docs/Reference/contexts/environments/clear.gen.md +++ b/docs/Reference/contexts/environments/clear.gen.md @@ -4,7 +4,7 @@ Unset the default environment of the current context -**Aliases:** clear +**Aliases:** `clear` **Usage:** diff --git a/docs/Reference/contexts/environments/get.gen.md b/docs/Reference/contexts/environments/get.gen.md index a3510ee..e0d9ff7 100644 --- a/docs/Reference/contexts/environments/get.gen.md +++ b/docs/Reference/contexts/environments/get.gen.md @@ -4,7 +4,7 @@ Get the default environment of the current context -**Aliases:** get +**Aliases:** `get` **Usage:** diff --git a/docs/Reference/contexts/environments/index.gen.md b/docs/Reference/contexts/environments/index.gen.md index fc8d07c..97e58ab 100644 --- a/docs/Reference/contexts/environments/index.gen.md +++ b/docs/Reference/contexts/environments/index.gen.md @@ -4,7 +4,7 @@ Manage the default environment -**Aliases:** environments, environment, envs, env, workspaces, workspace +**Aliases:** `environments`, `environment`, `envs`, `env`, `workspaces`, `workspace` **Usage:** diff --git a/docs/Reference/contexts/environments/use.gen.md b/docs/Reference/contexts/environments/use.gen.md index 5cb693f..790df4f 100644 --- a/docs/Reference/contexts/environments/use.gen.md +++ b/docs/Reference/contexts/environments/use.gen.md @@ -4,7 +4,7 @@ Select the default environment for the current context -**Aliases:** use +**Aliases:** `use` **Usage:** diff --git a/docs/Reference/contexts/index.gen.md b/docs/Reference/contexts/index.gen.md index 01b6ae9..cceddea 100644 --- a/docs/Reference/contexts/index.gen.md +++ b/docs/Reference/contexts/index.gen.md @@ -2,9 +2,9 @@ ## Overview -Manage the contexts for the CLI +Manage alternative contexts for the CLI when using Dedicated or BYOC clusters -**Aliases:** contexts, context, ctx +**Aliases:** `contexts`, `context`, `ctx` **Usage:** @@ -14,7 +14,7 @@ quix contexts [command] [options] **Commands:** -- [broker](broker\index.md) : Manage the local debug broker configuration of the current context +- [broker](broker\index.md) : Manage the Sdk broker configuration that is injected to QuixStreams while developing locally - [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 diff --git a/docs/Reference/contexts/list.gen.md b/docs/Reference/contexts/list.gen.md index 299ebc9..e6823d4 100644 --- a/docs/Reference/contexts/list.gen.md +++ b/docs/Reference/contexts/list.gen.md @@ -4,7 +4,7 @@ Get all contexts -**Aliases:** list, ls +**Aliases:** `list`, `ls` **Usage:** diff --git a/docs/Reference/contexts/reset.gen.md b/docs/Reference/contexts/reset.gen.md index 8566182..9c60b82 100644 --- a/docs/Reference/contexts/reset.gen.md +++ b/docs/Reference/contexts/reset.gen.md @@ -4,7 +4,7 @@ Resets your context to defaults -**Aliases:** reset +**Aliases:** `reset` **Usage:** diff --git a/docs/Reference/contexts/use.gen.md b/docs/Reference/contexts/use.gen.md index bdad574..eb65b5a 100644 --- a/docs/Reference/contexts/use.gen.md +++ b/docs/Reference/contexts/use.gen.md @@ -4,7 +4,7 @@ Uses the specified context -**Aliases:** use +**Aliases:** `use` **Usage:** diff --git a/docs/Reference/environments/use.md b/docs/Reference/environments/use.md deleted file mode 100644 index 663ac1e..0000000 --- a/docs/Reference/environments/use.md +++ /dev/null @@ -1,5 +0,0 @@ -{% include-markdown './use.gen.md' %} -!!! info - - Used as an Alias for [this](../use.md) command - diff --git a/docs/Reference/local/ide.gen.md b/docs/Reference/ide.gen.md similarity index 68% rename from docs/Reference/local/ide.gen.md rename to docs/Reference/ide.gen.md index e6ed340..3067cf4 100644 --- a/docs/Reference/local/ide.gen.md +++ b/docs/Reference/ide.gen.md @@ -1,15 +1,15 @@ -# local ide +# ide ## Overview -Setup everything needed for local application development and open your local IDE +Launch your local IDE configuring all the settings for local application development -**Aliases:** ide, develop, dev +**Aliases:** `ide` **Usage:** ``` -quix local ide [] [options] +quix ide [] [options] ``` **Arguments:** diff --git a/docs/Reference/local/ide.md b/docs/Reference/ide.md similarity index 85% rename from docs/Reference/local/ide.md rename to docs/Reference/ide.md index bc45e71..ebff461 100644 --- a/docs/Reference/local/ide.md +++ b/docs/Reference/ide.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local ide` command sets up your development environment for a specified application by generating all necessary IDE-dependent files. This integration allows you to run and debug your application directly from your chosen IDE. +The `quix ide` command sets up your development environment for a specified application by generating all necessary IDE-dependent files. This integration allows you to run and debug your application directly from your chosen IDE. This command is particularly useful the first time you edit an application, as it automates the setup process. While you can run it multiple times, its primary benefits are realized during the initial setup. @@ -13,13 +13,13 @@ This command is particularly useful the first time you edit an application, as i Each time you run or debug your code using the generated run configuration, the command exports variables from the `app.yaml` file to a `.env` file or a devcontainer configuration. This ensures that the environment is correctly set up before you begin editing and debugging. -Specifically, this command executes [`quix local application variables export`](applications/variables/export.md), which adds the application values along with the broker or SDK token to a `.env` file. +Specifically, this command executes [`quix application variables export`](../applications/variables/export.md), which adds the application values along with the broker or SDK token to a `.env` file. #### Debug Broker Configuration === "Pipeline Broker" - To use a local debug broker, you can easily set one up by running `quix local broker up`. This will start a local broker instance that listens on `localhost:19092`. This setting is enabled by default. If you need to change it, use `quix context broker local`. + To use a local debug broker, you can easily set one up by running `quix broker up`. This will start a local broker instance that listens on `localhost:19092`. This setting is enabled by default. If you need to change it, use `quix context broker local`. === "Quix Cloud Broker" @@ -52,14 +52,14 @@ Quix__Sdk__Token={your_token} === "VS Code" - For VS Code, the `quix local ide` command generates the necessary configurations to ensure smooth debugging and development: + For VS Code, the `quix ide` command generates the necessary configurations to ensure smooth debugging and development: - **launch.json**: Configures the Python debugger to use the integrated terminal. It includes a pre-launch task `quix-variables-export` to set environment variables correctly before debugging. - **tasks.json**: Defines a custom task `quix-variables-export` that exports application variables from the `app.yaml` file to a `.env` file. This task is executed before running the debugger. === "PyCharm" - For PyCharm, the `quix local ide` command generates configurations to facilitate debugging: + For PyCharm, the `quix ide` command generates configurations to facilitate debugging: - **Quix.xml**: Configures a run configuration that includes a pre-launch task to export environment variables using the `quix-variables-export` external tool. - **External Tools.xml**: Defines an external tool to export application variables from the `app.yaml` file to a `.env` file. This tool runs before the main application execution starts. @@ -88,7 +88,7 @@ For more information on Dev Containers, visit [Dev Containers](https://container When you execute the local ide command without any options: ```bash -$ quix local ide +$ quix ide ``` The interactive command starts. If your current directory is not an application directory, you are prompted to select the application you want to edit and debug in your IDE: diff --git a/docs/Reference/local/init.gen.md b/docs/Reference/init.gen.md similarity index 88% rename from docs/Reference/local/init.gen.md rename to docs/Reference/init.gen.md index cecc1f2..1e02414 100644 --- a/docs/Reference/local/init.gen.md +++ b/docs/Reference/init.gen.md @@ -1,15 +1,15 @@ -# local init +# init ## Overview Generate the initial Quix files based on the existing repository -**Aliases:** init +**Aliases:** `init` **Usage:** ``` -quix local init [] [options] +quix init [] [options] ``` **Arguments:** diff --git a/docs/Reference/local/init.md b/docs/Reference/init.md similarity index 61% rename from docs/Reference/local/init.md rename to docs/Reference/init.md index d24cc9a..e1fa41e 100644 --- a/docs/Reference/local/init.md +++ b/docs/Reference/init.md @@ -1,12 +1,12 @@ {% include-markdown './init.gen.md' %} ## How It Works -The `quix local init` command sets up the initial Quix files based on your existing repository. When executed, it generates the necessary configuration files such as `dockerfile` and `app.yaml` for your application. +The `quix init` command sets up the initial Quix files based on your existing repository. When executed, it generates the necessary configuration files such as `dockerfile` and `app.yaml` for your application. If run at the root level of your project, it will also create a `quix.yaml` file if one does not exist, and it attempts to generate any missing `app.yaml` and `dockerfile` files for all applications within the project. This ensures that your development environment is properly configured for seamless development and deployment. !!! tip - The `-dev, --devcontainers`, `--vscode`, `--pycharm`, and `--ide ` options work similarly to those in the [`quix local ide`](ide.md) command. + The `-dev, --devcontainers`, `--vscode`, `--pycharm`, and `--ide ` options work similarly to those in the [`quix debug ide`](debug/ide.md) command. ## Example usage @@ -15,16 +15,16 @@ If run at the root level of your project, it will also create a `quix.yaml` file If you have a Python file named `main.py` and you want to create a Quix application from it, you can use the following command: ```bash -$ quix local init +$ quix init ``` When you run this command, it will automatically generate a `dockerfile` and an `app.yaml` file for your application. These files are essential for containerizing your application and defining its configuration, allowing you to easily deploy and manage your application in a consistent environment. -Using `quix local init` simplifies the process of setting up your application, ensuring that all required files are created and properly configured. +Using `quix init` simplifies the process of setting up your application, ensuring that all required files are created and properly configured. ### Additional Functionality -If you run the `quix local init` command at the root level of your project directory, it generates an empty `quix.yaml` file if it's not there yet. Additionally, it will attempt to generate any missing `app.yaml` and `dockerfile` for all applications within the project. +If you run the `quix init` command at the root level of your project directory, it generates an empty `quix.yaml` file if it's not there yet. Additionally, it will attempt to generate any missing `app.yaml` and `dockerfile` for all applications within the project. Running the command at the root level ensures that your entire project is properly initialized and configured, with all necessary files created for seamless development and deployment. diff --git a/docs/Reference/local/applications/index.gen.md b/docs/Reference/local/applications/index.gen.md deleted file mode 100644 index c533a03..0000000 --- a/docs/Reference/local/applications/index.gen.md +++ /dev/null @@ -1,21 +0,0 @@ -# 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 - diff --git a/docs/Reference/local/applications/list.gen.md b/docs/Reference/local/applications/list.gen.md deleted file mode 100644 index 332bfee..0000000 --- a/docs/Reference/local/applications/list.gen.md +++ /dev/null @@ -1,19 +0,0 @@ -# local applications list - -## Overview - -lists local applications - -**Aliases:** list, ls - -**Usage:** - -``` -quix local applications list [options] -``` - -**Options:** - -- `-o, --output ` : Output type of the retrieved data -- `-d, --directory ` : Base directory (defaults to current directory) - diff --git a/docs/Reference/local/index.gen.md b/docs/Reference/local/index.gen.md deleted file mode 100644 index f1056d2..0000000 --- a/docs/Reference/local/index.gen.md +++ /dev/null @@ -1,22 +0,0 @@ -# local - -## Overview - -Performs local related operations - -**Aliases:** local - -**Usage:** - -``` -quix local [command] [options] -``` - -**Commands:** - -- [applications](applications\index.md) : Manage your local applications -- [broker](broker\index.md) : Manage the local broker instance -- [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 - diff --git a/docs/Reference/local/variables/export.gen.md b/docs/Reference/local/variables/export.gen.md deleted file mode 100644 index fa4d2ad..0000000 --- a/docs/Reference/local/variables/export.gen.md +++ /dev/null @@ -1,21 +0,0 @@ -# local variables export - -## Overview - -Exports the variables from app.yaml to an .env file - -**Aliases:** export, exp, export-to-dotenv - -**Usage:** - -``` -quix local variables export [options] -``` - -**Options:** - -- `--workspace-id ` : -- `--env-file-name ` : [default: .env] -- `--directory ` : Base directory (defaults to current directory) -- `--reset` : Removes all the values of existing env variables and adds them from the app.yaml file [default: False] - diff --git a/docs/Reference/local/variables/export.md b/docs/Reference/local/variables/export.md deleted file mode 100644 index a1a7d41..0000000 --- a/docs/Reference/local/variables/export.md +++ /dev/null @@ -1 +0,0 @@ -{% include-markdown './export.gen.md' %} \ No newline at end of file diff --git a/docs/Reference/login.gen.md b/docs/Reference/login.gen.md index 67aabef..27bdfd1 100644 --- a/docs/Reference/login.gen.md +++ b/docs/Reference/login.gen.md @@ -4,7 +4,7 @@ Login to your Quix Cloud account -**Aliases:** login +**Aliases:** `login` **Usage:** diff --git a/docs/Reference/login.md b/docs/Reference/login.md index a9ba473..b43b7b7 100644 --- a/docs/Reference/login.md +++ b/docs/Reference/login.md @@ -41,4 +41,4 @@ https://auth.quix.ai/activate?user_code=XVHF-MSMG In the interactive login process, a URL and a user code are provided. If your browser does not open automatically, you can manually navigate to the URL and enter the user code to complete the login process. This ensures a secure and straightforward login experience. -By following these steps, you can easily authenticate to your Quix account using either method. +By following these steps, you can easily authenticate to your Quix account using either method. \ No newline at end of file diff --git a/docs/Reference/logout.gen.md b/docs/Reference/logout.gen.md new file mode 100644 index 0000000..86828c6 --- /dev/null +++ b/docs/Reference/logout.gen.md @@ -0,0 +1,14 @@ +# logout + +## Overview + +Logout from your Quix Cloud account + +**Aliases:** `logout` + +**Usage:** + +``` +quix logout [options] +``` + diff --git a/docs/Reference/logout.md b/docs/Reference/logout.md new file mode 100644 index 0000000..3cfa903 --- /dev/null +++ b/docs/Reference/logout.md @@ -0,0 +1 @@ +{% include-markdown './logout.gen.md' %} \ No newline at end of file diff --git a/docs/Reference/local/broker/down.gen.md b/docs/Reference/pipeline/broker/down.gen.md similarity index 52% rename from docs/Reference/local/broker/down.gen.md rename to docs/Reference/pipeline/broker/down.gen.md index 903bc8a..1417953 100644 --- a/docs/Reference/local/broker/down.gen.md +++ b/docs/Reference/pipeline/broker/down.gen.md @@ -1,15 +1,15 @@ -# local broker down +# pipeline broker down ## Overview -Stop the local broker instance and all the services depending on it +Stop the broker instance of the local pipeline and all the services depending on it -**Aliases:** down, stop +**Aliases:** `down`, `stop` **Usage:** ``` -quix local broker down [options] +quix pipeline broker down [options] ``` **Options:** diff --git a/docs/Reference/local/broker/down.md b/docs/Reference/pipeline/broker/down.md similarity index 82% rename from docs/Reference/local/broker/down.md rename to docs/Reference/pipeline/broker/down.md index 753e149..8f4d96a 100644 --- a/docs/Reference/local/broker/down.md +++ b/docs/Reference/pipeline/broker/down.md @@ -1,8 +1,10 @@ {% include-markdown './down.gen.md' %} +{% include-markdown './down.gen.md' %} + ## How It Works -The `quix local 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 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. If the force option is used, the command bypasses all safety checks, allowing for an immediate shutdown without any prompts or checks. @@ -15,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 local broker down +$ quix pipeline broker down ``` This command stops and removes the Docker containers: diff --git a/docs/Reference/pipeline/broker/index.gen.md b/docs/Reference/pipeline/broker/index.gen.md new file mode 100644 index 0000000..982e7b1 --- /dev/null +++ b/docs/Reference/pipeline/broker/index.gen.md @@ -0,0 +1,19 @@ +# pipeline broker + +## Overview + +Manage the broker instance of the local pipeline + +**Aliases:** `broker` + +**Usage:** + +``` +quix pipeline broker [command] [options] +``` + +**Commands:** + +- [down](down.md) : Stop the broker instance of the local pipeline and all the services depending on it +- [up](up.md) : Start the broker instance of the local pipeline + diff --git a/docs/Reference/users/permissions/index.md b/docs/Reference/pipeline/broker/index.md similarity index 100% rename from docs/Reference/users/permissions/index.md rename to docs/Reference/pipeline/broker/index.md diff --git a/docs/Reference/local/broker/up.gen.md b/docs/Reference/pipeline/broker/up.gen.md similarity index 62% rename from docs/Reference/local/broker/up.gen.md rename to docs/Reference/pipeline/broker/up.gen.md index d1b7e1e..75481cc 100644 --- a/docs/Reference/local/broker/up.gen.md +++ b/docs/Reference/pipeline/broker/up.gen.md @@ -1,15 +1,15 @@ -# local broker up +# pipeline broker up ## Overview -Start the local broker instance +Start the broker instance of the local pipeline -**Aliases:** up, run +**Aliases:** `up`, `run` **Usage:** ``` -quix local broker up [options] +quix pipeline broker up [options] ``` **Options:** diff --git a/docs/Reference/local/broker/up.md b/docs/Reference/pipeline/broker/up.md similarity index 87% rename from docs/Reference/local/broker/up.md rename to docs/Reference/pipeline/broker/up.md index 74f744b..4570de3 100644 --- a/docs/Reference/local/broker/up.md +++ b/docs/Reference/pipeline/broker/up.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local broker up` command sets up and runs your local broker instance using Docker Compose. When executed, it generates the necessary `compose.yaml` file that defines the broker services required for your setup. It then builds and starts the Docker containers based on this configuration by running the equivalent of `docker compose up --build -d --remove-orphans`. +The `quix pipeline broker up` command sets up and runs your local broker instance using Docker Compose. When executed, it generates the necessary `compose.yaml` file that defines the broker services required for your setup. It then builds and starts the Docker containers based on this configuration by running the equivalent of `docker compose up --build -d --remove-orphans`. If the dry-run option is used, the command allows you to generate the `compose.yaml` file without starting the containers, providing a preview of the configuration. This is particularly useful for validating your setup before making any changes to your running environment. @@ -22,7 +22,7 @@ Deployments are connected using variables that ensure seamless data flow between To start your local broker, use the following command: ```bash -$ quix local broker up +$ quix pipeline broker up ``` This command generates the necessary `compose.yaml` file and deployment configurations: diff --git a/docs/Reference/local/pipeline/deployments/create.gen.md b/docs/Reference/pipeline/deployments/create.gen.md similarity index 73% rename from docs/Reference/local/pipeline/deployments/create.gen.md rename to docs/Reference/pipeline/deployments/create.gen.md index 0c3db4e..1265a73 100644 --- a/docs/Reference/local/pipeline/deployments/create.gen.md +++ b/docs/Reference/pipeline/deployments/create.gen.md @@ -1,24 +1,24 @@ -# local pipeline deployments create - -## Overview - -Add a local deployment - -**Aliases:** create, add - -**Usage:** - -``` -quix local pipeline deployments create [] [options] -``` - -**Arguments:** - -- `` : The ID or path of the application you want to deploy - -**Options:** - -- `--name ` : Name of the deployment (defaults to the name of the application) -- `--directory ` : Base directory (defaults to current directory) -- `--version ` : Selects the version of the application to deploy (latest/commit/tag) - +# pipeline deployments create + +## Overview + +Add a local deployment + +**Aliases:** `create`, `add` + +**Usage:** + +``` +quix pipeline deployments create [] [options] +``` + +**Arguments:** + +- `` : The ID or path of the application you want to deploy + +**Options:** + +- `--name ` : Name of the deployment (defaults to the name of the application) +- `--directory ` : Base directory (defaults to current directory) +- `--version ` : Selects the version of the application to deploy (latest/commit/tag) + diff --git a/docs/Reference/users/tokens/create.md b/docs/Reference/pipeline/deployments/create.md similarity index 100% rename from docs/Reference/users/tokens/create.md rename to docs/Reference/pipeline/deployments/create.md diff --git a/docs/Reference/local/pipeline/deployments/delete.gen.md b/docs/Reference/pipeline/deployments/delete.gen.md similarity index 58% rename from docs/Reference/local/pipeline/deployments/delete.gen.md rename to docs/Reference/pipeline/deployments/delete.gen.md index b055d85..de2c407 100644 --- a/docs/Reference/local/pipeline/deployments/delete.gen.md +++ b/docs/Reference/pipeline/deployments/delete.gen.md @@ -1,22 +1,22 @@ -# local pipeline deployments delete - -## Overview - -Delete a local deployment - -**Aliases:** delete, del, remove, rm - -**Usage:** - -``` -quix local pipeline deployments delete [] [options] -``` - -**Arguments:** - -- `` : The name of the deployment to edit - -**Options:** - -- `--directory ` : Base directory (defaults to current directory) - +# pipeline deployments delete + +## Overview + +Delete a local deployment + +**Aliases:** `delete`, `del`, `remove`, `rm` + +**Usage:** + +``` +quix pipeline deployments delete [] [options] +``` + +**Arguments:** + +- `` : The name of the deployment to edit + +**Options:** + +- `--directory ` : Base directory (defaults to current directory) + diff --git a/docs/Reference/local/pipeline/deployments/delete.md b/docs/Reference/pipeline/deployments/delete.md similarity index 100% rename from docs/Reference/local/pipeline/deployments/delete.md rename to docs/Reference/pipeline/deployments/delete.md diff --git a/docs/Reference/local/pipeline/deployments/edit.gen.md b/docs/Reference/pipeline/deployments/edit.gen.md similarity index 69% rename from docs/Reference/local/pipeline/deployments/edit.gen.md rename to docs/Reference/pipeline/deployments/edit.gen.md index bda9256..99f39f3 100644 --- a/docs/Reference/local/pipeline/deployments/edit.gen.md +++ b/docs/Reference/pipeline/deployments/edit.gen.md @@ -1,23 +1,23 @@ -# local pipeline deployments edit - -## Overview - -Edit a local deployment - -**Aliases:** edit - -**Usage:** - -``` -quix local pipeline deployments edit [] [options] -``` - -**Arguments:** - -- `` : The name of the deployment to edit - -**Options:** - -- `--directory ` : Base directory (defaults to current directory) -- `--version ` : Selects the version of the application to deploy (latest/commit/tag) - +# pipeline deployments edit + +## Overview + +Edit a local deployment + +**Aliases:** `edit` + +**Usage:** + +``` +quix pipeline deployments edit [] [options] +``` + +**Arguments:** + +- `` : The name of the deployment to edit + +**Options:** + +- `--directory ` : Base directory (defaults to current directory) +- `--version ` : Selects the version of the application to deploy (latest/commit/tag) + diff --git a/docs/Reference/users/tokens/edit.md b/docs/Reference/pipeline/deployments/edit.md similarity index 100% rename from docs/Reference/users/tokens/edit.md rename to docs/Reference/pipeline/deployments/edit.md diff --git a/docs/Reference/local/pipeline/deployments/get.gen.md b/docs/Reference/pipeline/deployments/get.gen.md similarity index 70% rename from docs/Reference/local/pipeline/deployments/get.gen.md rename to docs/Reference/pipeline/deployments/get.gen.md index 2d2e520..40686aa 100644 --- a/docs/Reference/local/pipeline/deployments/get.gen.md +++ b/docs/Reference/pipeline/deployments/get.gen.md @@ -1,15 +1,15 @@ -# local pipeline deployments get +# pipeline deployments get ## Overview Get a local deployment -**Aliases:** get +**Aliases:** `get` **Usage:** ``` -quix local pipeline deployments get [] [options] +quix pipeline deployments get [] [options] ``` **Arguments:** diff --git a/docs/Reference/topics/get.md b/docs/Reference/pipeline/deployments/get.md similarity index 100% rename from docs/Reference/topics/get.md rename to docs/Reference/pipeline/deployments/get.md diff --git a/docs/Reference/local/pipeline/deployments/index.gen.md b/docs/Reference/pipeline/deployments/index.gen.md similarity index 64% rename from docs/Reference/local/pipeline/deployments/index.gen.md rename to docs/Reference/pipeline/deployments/index.gen.md index 26390be..a5303b1 100644 --- a/docs/Reference/local/pipeline/deployments/index.gen.md +++ b/docs/Reference/pipeline/deployments/index.gen.md @@ -1,15 +1,15 @@ -# local pipeline deployments +# pipeline deployments ## Overview -Manage the local deployments +Manage the deployments of the local pipeline -**Aliases:** deployments, deployment +**Aliases:** `deployments`, `deployment` **Usage:** ``` -quix local pipeline deployments [command] [options] +quix pipeline deployments [command] [options] ``` **Commands:** diff --git a/docs/Reference/users/tokens/index.md b/docs/Reference/pipeline/deployments/index.md similarity index 100% rename from docs/Reference/users/tokens/index.md rename to docs/Reference/pipeline/deployments/index.md diff --git a/docs/Reference/local/pipeline/deployments/list.gen.md b/docs/Reference/pipeline/deployments/list.gen.md similarity index 64% rename from docs/Reference/local/pipeline/deployments/list.gen.md rename to docs/Reference/pipeline/deployments/list.gen.md index a8a31aa..d6975f0 100644 --- a/docs/Reference/local/pipeline/deployments/list.gen.md +++ b/docs/Reference/pipeline/deployments/list.gen.md @@ -1,19 +1,19 @@ -# local pipeline deployments list - -## Overview - -List all the local deployments - -**Aliases:** list, ls - -**Usage:** - -``` -quix local pipeline deployments list [options] -``` - -**Options:** - -- `--directory ` : Base directory (defaults to current directory) -- `-o, --output ` : Output type of the retrieved data - +# pipeline deployments list + +## Overview + +List all the local deployments + +**Aliases:** `list`, `ls` + +**Usage:** + +``` +quix pipeline deployments list [options] +``` + +**Options:** + +- `--directory ` : Base directory (defaults to current directory) +- `-o, --output ` : Output type of the retrieved data + diff --git a/docs/Reference/users/tokens/list.md b/docs/Reference/pipeline/deployments/list.md similarity index 100% rename from docs/Reference/users/tokens/list.md rename to docs/Reference/pipeline/deployments/list.md diff --git a/docs/Reference/local/pipeline/down.gen.md b/docs/Reference/pipeline/down.gen.md similarity index 70% rename from docs/Reference/local/pipeline/down.gen.md rename to docs/Reference/pipeline/down.gen.md index d42a226..87c44dd 100644 --- a/docs/Reference/local/pipeline/down.gen.md +++ b/docs/Reference/pipeline/down.gen.md @@ -1,19 +1,19 @@ -# local pipeline down - -## Overview - -Stop the execution of your local pipeline - -**Aliases:** down, stop - -**Usage:** - -``` -quix local pipeline down [options] -``` - -**Options:** - +# pipeline down + +## Overview + +Stop the execution of your local pipeline + +**Aliases:** `down`, `stop` + +**Usage:** + +``` +quix pipeline down [options] +``` + +**Options:** + - `--directory ` : If specified, it will use that directory instead of the current one -- `--keep-broker` : Keep the local broker running - +- `--keep-broker` : Keep the local broker running + diff --git a/docs/Reference/local/pipeline/down.md b/docs/Reference/pipeline/down.md similarity index 89% rename from docs/Reference/local/pipeline/down.md rename to docs/Reference/pipeline/down.md index 4e1f641..e9425a2 100644 --- a/docs/Reference/local/pipeline/down.md +++ b/docs/Reference/pipeline/down.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local pipeline down` command stops and removes all the Docker containers defined in your `compose.yaml` file. It acts as a shortcut for the `docker compose down` command, ensuring that all running services are stopped and all associated containers, networks, and volumes are removed. +The `quix pipeline down` command stops and removes all the Docker containers defined in your `compose.yaml` file. It acts as a shortcut for the `docker compose down` command, ensuring that all running services are stopped and all associated containers, networks, and volumes are removed. When executed, this command performs the following steps: @@ -26,7 +26,7 @@ This process ensures that your environment is clean and ready for the next time To stop and remove all the containers defined in your `compose.yaml` file, use the following command: ```bash -$ quix local pipeline down +$ quix pipeline down ``` !!! tip diff --git a/docs/Reference/local/pipeline/index.gen.md b/docs/Reference/pipeline/index.gen.md similarity index 63% rename from docs/Reference/local/pipeline/index.gen.md rename to docs/Reference/pipeline/index.gen.md index 23a0a10..abefb87 100644 --- a/docs/Reference/local/pipeline/index.gen.md +++ b/docs/Reference/pipeline/index.gen.md @@ -1,24 +1,25 @@ -# local pipeline +# pipeline ## Overview -Manage your local pipeline and your 'quix.yaml' +Manage your local pipeline operations and resources -**Aliases:** pipeline, pipe +**Aliases:** `pipeline`, `pipe` **Usage:** ``` -quix local pipeline [command] [options] +quix pipeline [command] [options] ``` **Commands:** - [view](view.md) : Create and preview a mermaid diagram of the pipeline -- [deployments](deployments\index.md) : Manage the local deployments +- [broker](broker\index.md) : Manage the broker instance of the local pipeline +- [deployments](deployments\index.md) : Manage the deployments of the local pipeline - [status](status.md) : Display the current status of the local pipeline - [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. +- [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 diff --git a/docs/Reference/pipeline/index.md b/docs/Reference/pipeline/index.md new file mode 100644 index 0000000..2bd196e --- /dev/null +++ b/docs/Reference/pipeline/index.md @@ -0,0 +1 @@ +{% include-markdown './index.gen.md' %} \ No newline at end of file diff --git a/docs/Reference/local/pipeline/status.gen.md b/docs/Reference/pipeline/status.gen.md similarity index 71% rename from docs/Reference/local/pipeline/status.gen.md rename to docs/Reference/pipeline/status.gen.md index c1a274b..1272d60 100644 --- a/docs/Reference/local/pipeline/status.gen.md +++ b/docs/Reference/pipeline/status.gen.md @@ -1,15 +1,15 @@ -# local pipeline status +# pipeline status ## Overview Display the current status of the local pipeline -**Aliases:** status +**Aliases:** `status` **Usage:** ``` -quix local pipeline status [options] +quix pipeline status [options] ``` **Options:** diff --git a/docs/Reference/local/pipeline/status.md b/docs/Reference/pipeline/status.md similarity index 73% rename from docs/Reference/local/pipeline/status.md rename to docs/Reference/pipeline/status.md index f20694a..2cf72d4 100644 --- a/docs/Reference/local/pipeline/status.md +++ b/docs/Reference/pipeline/status.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local pipeline status` command retrieves the current status of the local pipeline by executing the `docker compose ps --format json -a` command. This command fetches the status of all services defined in your `docker-compose` file and presents the relevant information in a concise and readable format. +The `quix pipeline status` command retrieves the current status of the local pipeline by executing the `docker compose ps --format json -a` command. This command fetches the status of all services defined in your `docker-compose` file and presents the relevant information in a concise and readable format. For more information, refer to the [Docker documentation](https://docs.docker.com/compose/reference/ps/). @@ -20,7 +20,7 @@ For more information, refer to the [Docker documentation](https://docs.docker.co To display the current status of your local pipeline, use the following command: ```bash -$ quix local pipeline status +$ quix pipeline status ``` #### All Services Running @@ -55,4 +55,4 @@ If no services are running, you will see the following message: Local Pipeline Status: Not Running ``` -By using the `quix local pipeline status` command, you can easily keep track of the state of your local pipeline and ensure that all necessary services are running smoothly. \ No newline at end of file +By using the `quix pipeline status` command, you can easily keep track of the state of your local pipeline and ensure that all necessary services are running smoothly. \ No newline at end of file diff --git a/docs/Reference/local/pipeline/sync.gen.md b/docs/Reference/pipeline/sync.gen.md similarity index 76% rename from docs/Reference/local/pipeline/sync.gen.md rename to docs/Reference/pipeline/sync.gen.md index 483999c..26c4c09 100644 --- a/docs/Reference/local/pipeline/sync.gen.md +++ b/docs/Reference/pipeline/sync.gen.md @@ -1,15 +1,15 @@ -# local pipeline sync +# pipeline sync ## Overview -Synchronize your local pipeline to Quix Cloud. +Synchronize your local pipeline to Quix Cloud -**Aliases:** sync, deploy +**Aliases:** `sync`, `deploy` **Usage:** ``` -quix local pipeline sync [options] +quix pipeline sync [options] ``` **Options:** diff --git a/docs/Reference/local/pipeline/sync.md b/docs/Reference/pipeline/sync.md similarity index 91% rename from docs/Reference/local/pipeline/sync.md rename to docs/Reference/pipeline/sync.md index 5242d2d..266a8b8 100644 --- a/docs/Reference/local/pipeline/sync.md +++ b/docs/Reference/pipeline/sync.md @@ -21,11 +21,11 @@ If your local repository is in sync with the remote, the command will: To synchronize your local pipeline to Quix Cloud without any additional options, use: ```bash -$ quix local pipeline sync +$ quix pipeline sync ``` !!! tip - Using the `--update` option will perform the same actions as running [`quix local pipeline update`](update.md) before syncing. + Using the `--update` option will perform the same actions as running [`quix pipeline update`](update.md) before syncing. This command stages all changes in your local repository: @@ -43,7 +43,7 @@ Executing commit ... Use the `--commit-message` option to include a meaningful commit message, making it easier to track changes: ```bash - $ quix local pipeline sync --commit-message "Initial deployment to Quix Cloud" + $ quix pipeline sync --commit-message "Initial deployment to Quix Cloud" ``` Finally, after it pushes the committed changes to the remote repository: diff --git a/docs/Reference/local/pipeline/up.gen.md b/docs/Reference/pipeline/up.gen.md similarity index 83% rename from docs/Reference/local/pipeline/up.gen.md rename to docs/Reference/pipeline/up.gen.md index 5a5d937..4a4f537 100644 --- a/docs/Reference/local/pipeline/up.gen.md +++ b/docs/Reference/pipeline/up.gen.md @@ -1,15 +1,15 @@ -# local pipeline up +# pipeline up ## Overview Run your pipeline using docker compose -**Aliases:** up, run +**Aliases:** `up`, `run` **Usage:** ``` -quix local pipeline up [options] +quix pipeline up [options] ``` **Options:** diff --git a/docs/Reference/local/pipeline/up.md b/docs/Reference/pipeline/up.md similarity index 87% rename from docs/Reference/local/pipeline/up.md rename to docs/Reference/pipeline/up.md index 5c6c6e5..c0b310a 100644 --- a/docs/Reference/local/pipeline/up.md +++ b/docs/Reference/pipeline/up.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local pipeline up` command sets up and runs your pipeline using Docker Compose. When executed, it generates the necessary `compose.yaml` file that defines the services in your pipeline. It then builds and starts the Docker containers based on this configuration by running the equivalent of `docker compose up --build -d`. +The `quix pipeline up` command sets up and runs your pipeline using Docker Compose. When executed, it generates the necessary `compose.yaml` file that defines the services in your pipeline. It then builds and starts the Docker containers based on this configuration by running the equivalent of `docker compose up --build -d`. If the update option is used, the command updates the `quix.yaml` file with new local applications and variables of existing deployments. The dry-run option allows you to generate the `compose.yaml` file without starting the containers, providing a preview of the configuration. @@ -23,7 +23,7 @@ This process ensures that your pipeline is correctly configured and running with To start your pipeline, use the following command: ```bash -$ quix local pipeline up +$ quix pipeline up ``` This command generates the necessary `compose.yaml` file and deployment configurations: @@ -41,7 +41,7 @@ Generating deployment event-detection-transformation You can also use the `--dry-run` option to generate the `compose.yaml` file without running it: ```bash - $ quix local pipeline up --dry-run + $ quix pipeline up --dry-run ``` Next, it executes `docker compose up --build -d --remove-orphans` to build and run the Docker containers: @@ -62,7 +62,7 @@ Containers Started ``` !!! tip - Using the `--update` option will perform the same actions as running [`quix local pipeline update`](update.md) before generating the `compose.yaml` file. + Using the `--update` option will perform the same actions as running [`quix pipeline update`](update.md) before generating the `compose.yaml` file. #### Generated `compose.yaml` File Overview diff --git a/docs/Reference/local/pipeline/update.gen.md b/docs/Reference/pipeline/update.gen.md similarity index 89% rename from docs/Reference/local/pipeline/update.gen.md rename to docs/Reference/pipeline/update.gen.md index 7af65ab..48e6c58 100644 --- a/docs/Reference/local/pipeline/update.gen.md +++ b/docs/Reference/pipeline/update.gen.md @@ -1,15 +1,15 @@ -# local pipeline update +# pipeline update ## Overview Update 'quix.yaml' with the new local applications and update the variables of the existing deployments -**Aliases:** update +**Aliases:** `update` **Usage:** ``` -quix local pipeline update [options] +quix pipeline update [options] ``` **Options:** diff --git a/docs/Reference/local/pipeline/update.md b/docs/Reference/pipeline/update.md similarity index 98% rename from docs/Reference/local/pipeline/update.md rename to docs/Reference/pipeline/update.md index b8fd788..e3558c5 100644 --- a/docs/Reference/local/pipeline/update.md +++ b/docs/Reference/pipeline/update.md @@ -22,7 +22,7 @@ During the update process, the command checks for any new variables or changes i When you execute the update local pipeline command without any options: ```bash -$ quix local pipeline update +$ quix pipeline update ``` The update process starts: diff --git a/docs/Reference/local/pipeline/view.gen.md b/docs/Reference/pipeline/view.gen.md similarity index 70% rename from docs/Reference/local/pipeline/view.gen.md rename to docs/Reference/pipeline/view.gen.md index 6d5e707..5b08103 100644 --- a/docs/Reference/local/pipeline/view.gen.md +++ b/docs/Reference/pipeline/view.gen.md @@ -1,15 +1,15 @@ -# local pipeline view +# pipeline view ## Overview Create and preview a mermaid diagram of the pipeline -**Aliases:** view, render +**Aliases:** `view`, `render` **Usage:** ``` -quix local pipeline view [options] +quix pipeline view [options] ``` **Options:** diff --git a/docs/Reference/local/pipeline/view.md b/docs/Reference/pipeline/view.md similarity index 88% rename from docs/Reference/local/pipeline/view.md rename to docs/Reference/pipeline/view.md index 7e9fc4e..5846424 100644 --- a/docs/Reference/local/pipeline/view.md +++ b/docs/Reference/pipeline/view.md @@ -2,7 +2,7 @@ ## How It Works -The `quix local pipeline view` command generates a visual representation of your pipeline using a mermaid diagram. When executed, it creates or updates the `pipeline.md` and `quix-pipeline.html` files in your project directory. +The `quix pipeline view` command generates a visual representation of your pipeline using a mermaid diagram. When executed, it creates or updates the `pipeline.md` and `quix-pipeline.html` files in your project directory. These files contain mermaid code that visualizes your pipeline's structure and data flow. The command can open these files in VS Code or your default browser, providing an interactive and up-to-date view of your pipeline configuration. This helps you easily visualize and document your pipeline setup. @@ -13,7 +13,7 @@ These files contain mermaid code that visualizes your pipeline's structure and d To view the pipeline documentation in VS Code, use the following command: ``` -$ quix local pipeline view +$ quix pipeline view ✓ 'pipeline.md' was updated ✓ VS Code started ``` @@ -35,7 +35,7 @@ demo-data-source[demo-data-source] -->|f1-data|event-detection-transformation[ev If you prefer not to use VS Code or it is not installed, you can still view the pipeline documentation in your browser. Use the same command: ``` -$ quix local pipeline view +$ quix pipeline view ``` This command will attempt to open the generated `quix-pipeline.html` file in your default browser. If it does not open automatically, you will see a message with a file path like this: diff --git a/docs/Reference/sdk/broker/cloud.gen.md b/docs/Reference/sdk/broker/cloud.gen.md new file mode 100644 index 0000000..3e6f67b --- /dev/null +++ b/docs/Reference/sdk/broker/cloud.gen.md @@ -0,0 +1,21 @@ +# sdk broker cloud + +## Overview + +Set the Sdk broker configuration to point to a 'Quix Cloud' broker + +**Aliases:** `cloud`, `disable` + +**Usage:** + +``` +quix sdk broker cloud [options] +``` + +**Options:** + +- `--workspace-id ` : The environment to use if your Sdk broker configuration is set to Quix Cloud +- `--env-file-name ` : Set the name of the environment file [default: .env] +- `--directory ` : Base directory (defaults to current directory) +- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration + diff --git a/docs/Reference/sdk/broker/cloud.md b/docs/Reference/sdk/broker/cloud.md new file mode 100644 index 0000000..cdf49c7 --- /dev/null +++ b/docs/Reference/sdk/broker/cloud.md @@ -0,0 +1 @@ +{% include-markdown './cloud.gen.md' %} \ No newline at end of file diff --git a/docs/Reference/sdk/broker/index.gen.md b/docs/Reference/sdk/broker/index.gen.md new file mode 100644 index 0000000..f6ff927 --- /dev/null +++ b/docs/Reference/sdk/broker/index.gen.md @@ -0,0 +1,21 @@ +# sdk broker + +## Overview + +Manage the Sdk broker configuration that is injected to QuixStreams while developing locally + +**Aliases:** `broker` + +**Usage:** + +``` +quix sdk broker [command] [options] +``` + +**Commands:** + +- [cloud](cloud.md) : Set the Sdk broker configuration to point to a 'Quix Cloud' broker +- [local](local.md) : Set the Sdk broker configuration to point to a 'Local' broker (default: pipeline broker) +- [set](set.md) : Set a local broker address for the Sdk broker configuration +- [update](update.md) : Update '.env' files of all the applications with the current Sdk broker configuration + diff --git a/docs/Reference/sdk/broker/index.md b/docs/Reference/sdk/broker/index.md new file mode 100644 index 0000000..2bd196e --- /dev/null +++ b/docs/Reference/sdk/broker/index.md @@ -0,0 +1 @@ +{% include-markdown './index.gen.md' %} \ No newline at end of file diff --git a/docs/Reference/sdk/broker/local.gen.md b/docs/Reference/sdk/broker/local.gen.md new file mode 100644 index 0000000..9e22844 --- /dev/null +++ b/docs/Reference/sdk/broker/local.gen.md @@ -0,0 +1,20 @@ +# sdk broker local + +## Overview + +Set the Sdk broker configuration to point to a 'Local' broker (default: pipeline broker) + +**Aliases:** `local`, `enable` + +**Usage:** + +``` +quix sdk broker local [options] +``` + +**Options:** + +- `--env-file-name ` : Set the name of the environment file [default: .env] +- `--directory ` : Base directory (defaults to current directory) +- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration + diff --git a/docs/Reference/sdk/broker/local.md b/docs/Reference/sdk/broker/local.md new file mode 100644 index 0000000..08d41ee --- /dev/null +++ b/docs/Reference/sdk/broker/local.md @@ -0,0 +1,5 @@ +{% include-markdown './local.gen.md' %} + +!!! info + + Used as an Alias for [this](../../contexts/broker/local.md) command \ No newline at end of file diff --git a/docs/Reference/sdk/broker/set.gen.md b/docs/Reference/sdk/broker/set.gen.md new file mode 100644 index 0000000..8359bb4 --- /dev/null +++ b/docs/Reference/sdk/broker/set.gen.md @@ -0,0 +1,26 @@ +# sdk broker set + +## Overview + +Set a local broker address for the Sdk broker configuration + +**Aliases:** `set` + +**Usage:** + +``` +quix sdk broker set [
] [options] +``` + +**Arguments:** + +- `
` : The broker address for the Sdk broker configuration (ie: localhost:19092) + +**Options:** + +- `--enable` : Enables Local broker as Sdk broker configuration +- `--workspace-id ` : The environment to use if your Sdk broker configuration is set to Quix Cloud +- `--env-file-name ` : Set the name of the environment file [default: .env] +- `--directory ` : Base directory (defaults to current directory) +- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration [] + diff --git a/docs/Reference/sdk/broker/set.md b/docs/Reference/sdk/broker/set.md new file mode 100644 index 0000000..a409548 --- /dev/null +++ b/docs/Reference/sdk/broker/set.md @@ -0,0 +1,4 @@ +{% include-markdown './set.gen.md' %} +!!! info + + Used as an Alias for [this](../../contexts/broker/set.md) command \ No newline at end of file diff --git a/docs/Reference/sdk/broker/update.gen.md b/docs/Reference/sdk/broker/update.gen.md new file mode 100644 index 0000000..c277f72 --- /dev/null +++ b/docs/Reference/sdk/broker/update.gen.md @@ -0,0 +1,20 @@ +# sdk broker update + +## Overview + +Update '.env' files of all the applications with the current Sdk broker configuration + +**Aliases:** `update` + +**Usage:** + +``` +quix sdk broker update [options] +``` + +**Options:** + +- `--workspace-id ` : The environment to use if your Sdk broker configuration is set to Quix Cloud +- `--env-file-name ` : Set the name of the environment file [default: .env] +- `--directory ` : Base directory (defaults to current directory) + diff --git a/docs/Reference/sdk/broker/update.md b/docs/Reference/sdk/broker/update.md new file mode 100644 index 0000000..f93a35f --- /dev/null +++ b/docs/Reference/sdk/broker/update.md @@ -0,0 +1 @@ +{% include-markdown './update.gen.md' %} \ No newline at end of file diff --git a/docs/Reference/sdk/index.gen.md b/docs/Reference/sdk/index.gen.md new file mode 100644 index 0000000..a7509f8 --- /dev/null +++ b/docs/Reference/sdk/index.gen.md @@ -0,0 +1,18 @@ +# sdk + +## Overview + +Set the Sdk configuration that is injected to QuixStreams while developing locally + +**Aliases:** `sdk`, `settings`, `config` + +**Usage:** + +``` +quix sdk [command] [options] +``` + +**Commands:** + +- [broker](broker\index.md) : Manage the Sdk broker configuration that is injected to QuixStreams while developing locally + diff --git a/docs/Reference/sdk/index.md b/docs/Reference/sdk/index.md new file mode 100644 index 0000000..2bd196e --- /dev/null +++ b/docs/Reference/sdk/index.md @@ -0,0 +1 @@ +{% include-markdown './index.gen.md' %} \ No newline at end of file diff --git a/docs/Reference/status.gen.md b/docs/Reference/status.gen.md index f3c2113..f979333 100644 --- a/docs/Reference/status.gen.md +++ b/docs/Reference/status.gen.md @@ -2,9 +2,9 @@ ## Overview -Global status check +Get a global status check of the settings, dependencies and services managed by the CLI -**Aliases:** status +**Aliases:** `status` **Usage:** diff --git a/docs/Reference/status.md b/docs/Reference/status.md index 4b35257..379818b 100644 --- a/docs/Reference/status.md +++ b/docs/Reference/status.md @@ -76,7 +76,7 @@ The status of your local pipeline is also displayed. If the pipeline is running ``` !!! tip - Use the [`quix local pipeline status`](local/pipeline/status.md) command to get detailed information about which services in your local pipeline are running and which are not. + Use the [`quix pipeline status`](pipeline/status.md) command to get detailed information about which services in your local pipeline are running and which are not. ### Git Repository Not Found diff --git a/docs/Reference/update.gen.md b/docs/Reference/update.gen.md index b80c1eb..a94aafe 100644 --- a/docs/Reference/update.gen.md +++ b/docs/Reference/update.gen.md @@ -4,7 +4,7 @@ Update the version of the CLI -**Aliases:** update +**Aliases:** `update` **Usage:** diff --git a/docs/Reference/use.gen.md b/docs/Reference/use.gen.md index 189d6cc..9d215c5 100644 --- a/docs/Reference/use.gen.md +++ b/docs/Reference/use.gen.md @@ -4,7 +4,7 @@ Select the default environment for the current context -**Aliases:** use +**Aliases:** `use` **Usage:** diff --git a/docs/cli-github-actions.md b/docs/cli-github-actions.md index 9e8fe8a..21e505c 100644 --- a/docs/cli-github-actions.md +++ b/docs/cli-github-actions.md @@ -10,7 +10,7 @@ Sometimes you might want to invoke certain commands of the Quix CLI from GitHub Using the Quix CLI, you can push any changes to your code, and sync the repo to Quix, by using the following command: ``` -quix local pipeline sync --update +quix pipeline sync --update ``` But sometimes, a developer may make code changes to a branch directly, without using the Quix CLI. In this case you could create a GitHub Action to make sure your repo is always synched to Quix. diff --git a/docs/cli-quickstart.md b/docs/cli-quickstart.md index f55dd10..3cab456 100644 --- a/docs/cli-quickstart.md +++ b/docs/cli-quickstart.md @@ -117,10 +117,10 @@ cd ## Step 6: Initialize your project as a Quix project -In your Git project directory, enter ```quix local init```. This initializes your Quix project with a `quix.yaml` file, which describes your Quix project. As a convenience a `.gitignore` file is also created for you, or if one is present it is updated to ignore files such as virtual environment files, `.env` files, and so on.: +In your Git project directory, enter ```quix init```. This initializes your Quix project with a `quix.yaml` file, which describes your Quix project. As a convenience a `.gitignore` file is also created for you, or if one is present it is updated to ignore files such as virtual environment files, `.env` files, and so on.: ``` -quix local init +quix init ``` @@ -152,7 +152,7 @@ You can see there are currently no applications (deployments) or topics. Now create a source application that will ingest simulated telemetry data into the broker as if it were coming from a real car in real-time: ``` -quix local app create demo-data-source +quix app create demo-data-source ``` When prompted, assign it a name of `demo-data-source`. @@ -164,7 +164,7 @@ This creates a demo data source for you. A directory has been created for this a Now let's create a simple transform application. This application will read data from the source and will generate a message when a hard braking is detected: ``` -quix local app create event-detection-transformation +quix app create event-detection-transformation ``` When prompted, assign it a name of `event-detection-transformation`. @@ -176,7 +176,7 @@ This creates the transform for you. A directory has been created for this applic Update your pipeline with the newly created applications of the project: ``` -quix local pipeline update +quix pipeline update ``` This command updates the deployment configuration of your pipeline based on the default configuration of your applications. @@ -237,21 +237,21 @@ You can see here the applications that are going to be deployed as part of the p View a graph representation of your local pipeline: ``` -quix local pipeline view +quix pipeline view ``` If you have VSCode installed, the pipeline is displayed in the IDE for you, otherwise the pipeline is displayed on your default browser: ![VSCode pipeline view](./images/cli/vscode-pipeline-view.png) -When you update your `quix.yaml` using the command `quix local pipeline update`, the visualization is updated for you. +When you update your `quix.yaml` using the command `quix pipeline update`, the visualization is updated for you. ## Step 11: Run your pipeline Run your pipeline in Docker based on your `quix.yaml` file: ``` -quix local pipeline up +quix pipeline up ``` You'll see various console messages displayed in your terminal. When these have finished, then your deployed services are running in Docker. @@ -277,7 +277,7 @@ You can see that hard braking has been detected. You can stop your pipeline with the following command: ``` -quix local pipeline down +quix pipeline down ``` If you switch to Docker Desktop, you'll see your container has been halted and removed. @@ -287,7 +287,7 @@ If you switch to Docker Desktop, you'll see your container has been halted and r To push your changes to Git, and sync your pipeline to Quix Cloud, enter: ``` -quix local pipeline sync +quix pipeline sync ``` This pushes all changes to your Git repository. If you view your repository in your Git provider (for example GitHub), you'll see your files have been pushed. diff --git a/docs/cli-template.md b/docs/cli-template.md index 343b527..494331c 100644 --- a/docs/cli-template.md +++ b/docs/cli-template.md @@ -65,7 +65,7 @@ There are various ways you can run your code locally. In this tutorial you run t 1. To run the pipeline locally, in your terminal enter the following command: ``` - quix local pipeline up + quix pipeline up ``` !!! tip @@ -77,7 +77,7 @@ There are various ways you can run your code locally. In this tutorial you run t 3. When you are satisfied the pipeline is running correctly, use the following command to shut down the pipeline: ``` - quix local pipeline down + quix pipeline down ``` ## Step 5: Modify your code @@ -89,7 +89,7 @@ You can now modify your code in any way you wish. For example, you could edit a Having worked on your code and tested it locally, you can now push up your code to deploy it in Quix Cloud. You can do this with: ``` -quix local pipeline sync --update +quix pipeline sync --update ``` This updates your `quix.yaml` and pushes your modified code to the Gitea repository and syncs with Quix Cloud. diff --git a/mkdocs.yml b/mkdocs.yml index a17f8c1..e8bd6f3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,173 +1,182 @@ -site_name: Quix Docs -site_description: Quix CLI Documentation -docs_dir: docs/ -repo_name: quixio/quix-cli -repo_url: https://github.com/quixio/quix-cli -edit_uri: tree/main/docs -exclude_docs: '*.gen.md' -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: blue grey - accent: blue - toggle: - icon: material/weather-night - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: indigo - accent: light blue - toggle: - icon: material/weather-sunny - name: Switch to light mode - features: - - navigation.path - - navigation.indexes - - content.tabs.link -markdown_extensions: -- attr_list -- md_in_html -- admonition -- footnotes -- pymdownx.critic -- pymdownx.caret -- pymdownx.keys -- pymdownx.mark -- pymdownx.tilde -- pymdownx.emoji: - emoji_index: !!python/name:material.extensions.emoji.twemoji '' - emoji_generator: !!python/name:material.extensions.emoji.to_svg '' -- pymdownx.details: -- pymdownx.highlight: - anchor_linenums: true -- pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:pymdownx.superfences.fence_code_format '' -- pymdownx.tabbed: - alternate_style: true -plugins: -- include-markdown -nav: -- 'Overview': 'overview.md' -- 'Quickstart': 'cli-quickstart.md' -- 'Tutorials': - - 'Using the CLI with a template': 'cli-template.md' - - 'Using the CLI with GitHub Actions': 'cli-github-actions.md' -- Reference: - - Remote Commands: - - organisations: - - Reference/organisations/index.md - - organisations get: Reference/organisations/get.md - - projects: - - Reference/projects/index.md - - projects patch: Reference/projects/patch.md - - projects get: Reference/projects/get.md - - projects list: Reference/projects/list.md - - environments: - - Reference/environments/index.md - - environments get: Reference/environments/get.md - - environments list: Reference/environments/list.md - - environments use: Reference/environments/use.md - - environments sync: Reference/environments/sync.md - - applications: - - Reference/applications/index.md - - applications get: Reference/applications/get.md - - applications list: Reference/applications/list.md - - applications library: - - Reference/applications/library/index.md - - applications library list: Reference/applications/library/list.md - - deployments: - - Reference/deployments/index.md - - deployments get: Reference/deployments/get.md - - deployments list: Reference/deployments/list.md - - deployments logs: Reference/deployments/logs.md - - deployments metrics: Reference/deployments/metrics.md - - deployments start: Reference/deployments/start.md - - deployments stop: Reference/deployments/stop.md - - topics: - - Reference/topics/index.md - - topics get: Reference/topics/get.md - - topics list: Reference/topics/list.md - - users: - - Reference/users/index.md - - users audit: Reference/users/audit.md - - users permissions: - - Reference/users/permissions/index.md - - users permissions copy: Reference/users/permissions/copy.md - - users permissions delete: Reference/users/permissions/delete.md - - users permissions edit: Reference/users/permissions/edit.md - - users permissions get: Reference/users/permissions/get.md - - users permissions list: Reference/users/permissions/list.md - - users permissions set: Reference/users/permissions/set.md - - users tokens: - - Reference/users/tokens/index.md - - users tokens create: Reference/users/tokens/create.md - - users tokens edit: Reference/users/tokens/edit.md - - users tokens list: Reference/users/tokens/list.md - - users tokens revoke: Reference/users/tokens/revoke.md - - users current: Reference/users/current.md - - users list: Reference/users/list.md - - Other Commands: - - contexts: - - Reference/contexts/index.md - - contexts broker: - - Reference/contexts/broker/index.md - - contexts broker cloud: Reference/contexts/broker/cloud.md - - contexts broker local: Reference/contexts/broker/local.md - - contexts broker set: Reference/contexts/broker/set.md - - contexts create: Reference/contexts/create.md - - contexts current: Reference/contexts/current.md - - contexts list: Reference/contexts/list.md - - contexts delete: Reference/contexts/delete.md - - contexts reset: Reference/contexts/reset.md - - contexts use: Reference/contexts/use.md - - contexts environments: - - Reference/contexts/environments/index.md - - contexts environments clear: Reference/contexts/environments/clear.md - - contexts environments get: Reference/contexts/environments/get.md - - contexts environments use: Reference/contexts/environments/use.md - - status: Reference/status.md - - use: Reference/use.md - - login: Reference/login.md - - update: Reference/update.md - - Local Commands: - - Reference/local/index.md - - local applications: - - Reference/local/applications/index.md - - local applications convert: Reference/local/applications/convert.md - - local applications create: Reference/local/applications/create.md - - local applications list: Reference/local/applications/list.md - - local applications variables: - - Reference/local/applications/variables/index.md - - local applications variables create: Reference/local/applications/variables/create.md - - local applications variables delete: Reference/local/applications/variables/delete.md - - local applications variables edit: Reference/local/applications/variables/edit.md - - local applications variables export: Reference/local/applications/variables/export.md - - local applications variables import: Reference/local/applications/variables/import.md - - local applications variables list: Reference/local/applications/variables/list.md - - local broker: - - Reference/local/broker/index.md - - local broker down: Reference/local/broker/down.md - - local broker up: Reference/local/broker/up.md - - local ide: Reference/local/ide.md - - local init: Reference/local/init.md - - local pipeline: - - Reference/local/pipeline/index.md - - local pipeline deployments: - - Reference/local/pipeline/deployments/index.md - - local pipeline deployments create: Reference/local/pipeline/deployments/create.md - - local pipeline deployments delete: Reference/local/pipeline/deployments/delete.md - - local pipeline deployments edit: Reference/local/pipeline/deployments/edit.md - - local pipeline deployments get: Reference/local/pipeline/deployments/get.md - - local pipeline deployments list: Reference/local/pipeline/deployments/list.md - - local pipeline down: Reference/local/pipeline/down.md - - local pipeline status: Reference/local/pipeline/status.md - - local pipeline sync: Reference/local/pipeline/sync.md - - local pipeline up: Reference/local/pipeline/up.md - - local pipeline update: Reference/local/pipeline/update.md - - local pipeline view: Reference/local/pipeline/view.md -... +site_name: Quix Docs +site_description: Quix CLI Documentation +docs_dir: docs/ +repo_name: quixio/quix-cli +repo_url: https://github.com/quixio/quix-cli +edit_uri: tree/main/docs +exclude_docs: '*.gen.md' +theme: + name: material + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: blue grey + accent: blue + toggle: + icon: material/weather-night + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: indigo + accent: light blue + toggle: + icon: material/weather-sunny + name: Switch to light mode + features: + - navigation.path + - navigation.indexes + - content.tabs.link +markdown_extensions: +- attr_list +- md_in_html +- admonition +- footnotes +- pymdownx.critic +- pymdownx.caret +- pymdownx.keys +- pymdownx.mark +- pymdownx.tilde +- pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji '' + emoji_generator: !!python/name:material.extensions.emoji.to_svg '' +- pymdownx.details: +- pymdownx.highlight: + anchor_linenums: true +- pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format '' +- pymdownx.tabbed: + alternate_style: true +plugins: +- include-markdown +nav: +- 'Overview': 'overview.md' +- 'Quickstart': 'cli-quickstart.md' +- 'Tutorials': + - 'Using the CLI with a template': 'cli-template.md' + - 'Using the CLI with GitHub Actions': 'cli-github-actions.md' +- Reference: + - Cloud Commands: + - Reference/cloud/index.md + - cloud applications: + - Reference/cloud/applications/index.md + - cloud applications get: Reference/cloud/applications/get.md + - cloud applications list: Reference/cloud/applications/list.md + - cloud applications library: + - Reference/cloud/applications/library/index.md + - cloud applications library list: Reference/cloud/applications/library/list.md + - cloud deployments: + - Reference/cloud/deployments/index.md + - cloud deployments get: Reference/cloud/deployments/get.md + - cloud deployments list: Reference/cloud/deployments/list.md + - cloud deployments logs: Reference/cloud/deployments/logs.md + - cloud deployments metrics: Reference/cloud/deployments/metrics.md + - cloud deployments start: Reference/cloud/deployments/start.md + - cloud deployments stop: Reference/cloud/deployments/stop.md + - cloud environments: + - Reference/cloud/environments/index.md + - cloud environments get: Reference/cloud/environments/get.md + - cloud environments list: Reference/cloud/environments/list.md + - cloud environments use: Reference/cloud/environments/use.md + - cloud environments sync: Reference/cloud/environments/sync.md + - cloud organisations: + - Reference/cloud/organisations/index.md + - cloud organisations get: Reference/cloud/organisations/get.md + - cloud projects: + - Reference/cloud/projects/index.md + - cloud projects patch: Reference/cloud/projects/patch.md + - cloud projects get: Reference/cloud/projects/get.md + - cloud projects list: Reference/cloud/projects/list.md + - cloud topics: + - Reference/cloud/topics/index.md + - cloud topics get: Reference/cloud/topics/get.md + - cloud topics list: Reference/cloud/topics/list.md + - cloud users: + - Reference/cloud/users/index.md + - cloud users audit: Reference/cloud/users/audit.md + - cloud users permissions: + - Reference/cloud/users/permissions/index.md + - cloud users permissions copy: Reference/cloud/users/permissions/copy.md + - cloud users permissions delete: Reference/cloud/users/permissions/delete.md + - cloud users permissions edit: Reference/cloud/users/permissions/edit.md + - cloud users permissions get: Reference/cloud/users/permissions/get.md + - cloud users permissions list: Reference/cloud/users/permissions/list.md + - cloud users permissions set: Reference/cloud/users/permissions/set.md + - cloud users tokens: + - Reference/cloud/users/tokens/index.md + - cloud users tokens create: Reference/cloud/users/tokens/create.md + - cloud users tokens edit: Reference/cloud/users/tokens/edit.md + - cloud users tokens list: Reference/cloud/users/tokens/list.md + - cloud users tokens revoke: Reference/cloud/users/tokens/revoke.md + - cloud users current: Reference/cloud/users/current.md + - cloud users list: Reference/cloud/users/list.md + - Local Commands: + - applications: + - Reference/applications/index.md + - applications convert: Reference/applications/convert.md + - applications create: Reference/applications/create.md + - applications list: Reference/applications/list.md + - applications variables: + - Reference/applications/variables/index.md + - applications variables create: Reference/applications/variables/create.md + - applications variables delete: Reference/applications/variables/delete.md + - applications variables edit: Reference/applications/variables/edit.md + - applications variables export: Reference/applications/variables/export.md + - applications variables import: Reference/applications/variables/import.md + - applications variables list: Reference/applications/variables/list.md + - ide: Reference/ide.md + - init: Reference/init.md + - pipeline: + - Reference/pipeline/index.md + - pipeline broker: + - Reference/pipeline/broker/index.md + - pipeline broker down: Reference/pipeline/broker/down.md + - pipeline broker up: Reference/pipeline/broker/up.md + - pipeline deployments: + - Reference/pipeline/deployments/index.md + - pipeline deployments create: Reference/pipeline/deployments/create.md + - pipeline deployments delete: Reference/pipeline/deployments/delete.md + - pipeline deployments edit: Reference/pipeline/deployments/edit.md + - pipeline deployments get: Reference/pipeline/deployments/get.md + - pipeline deployments list: Reference/pipeline/deployments/list.md + - pipeline down: Reference/pipeline/down.md + - pipeline status: Reference/pipeline/status.md + - pipeline sync: Reference/pipeline/sync.md + - pipeline up: Reference/pipeline/up.md + - pipeline update: Reference/pipeline/update.md + - pipeline view: Reference/pipeline/view.md + - sdk: + - Reference/sdk/index.md + - sdk broker: + - Reference/sdk/broker/index.md + - sdk broker cloud: Reference/sdk/broker/cloud.md + - sdk broker local: Reference/sdk/broker/local.md + - sdk broker set: Reference/sdk/broker/set.md + - sdk broker update: Reference/sdk/broker/update.md + - Other Commands: + - logout: Reference/logout.md + - login: Reference/login.md + - contexts: + - Reference/contexts/index.md + - contexts broker: + - Reference/contexts/broker/index.md + - contexts broker cloud: Reference/contexts/broker/cloud.md + - contexts broker local: Reference/contexts/broker/local.md + - contexts broker set: Reference/contexts/broker/set.md + - contexts create: Reference/contexts/create.md + - contexts current: Reference/contexts/current.md + - contexts list: Reference/contexts/list.md + - contexts delete: Reference/contexts/delete.md + - contexts reset: Reference/contexts/reset.md + - contexts use: Reference/contexts/use.md + - contexts environments: + - Reference/contexts/environments/index.md + - contexts environments clear: Reference/contexts/environments/clear.md + - contexts environments get: Reference/contexts/environments/get.md + - contexts environments use: Reference/contexts/environments/use.md + - status: Reference/status.md + - update: Reference/update.md + - use: Reference/use.md +...