Skip to content

Commit

Permalink
Updating refactored commands docs (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
emanuel-quix authored Jun 21, 2024
1 parent 7067cd1 commit caeec17
Show file tree
Hide file tree
Showing 194 changed files with 972 additions and 818 deletions.
Original file line number Diff line number Diff line change
@@ -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 <file-path> [options]
quix applications convert <file-path> [options]
```

**Arguments:**
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -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 [<library-item>] [options]
quix applications create [<library-item>] [options]
```

**Arguments:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:
Expand Down
11 changes: 6 additions & 5 deletions docs/Reference/applications/index.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand All @@ -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

18 changes: 0 additions & 18 deletions docs/Reference/applications/library/list.md

This file was deleted.

13 changes: 5 additions & 8 deletions docs/Reference/applications/list.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [<workspace-id>] [options]
quix applications list [options]
```

**Arguments:**

- `<workspace-id>` : The ID of the environment

**Options:**

- `-o, --output <json|table>` : Output type of the retrieved data
- `-o, --output <json|table>` : Output type of the retrieved data
- `-d, --directory <directory>` : Base directory (defaults to current directory)

28 changes: 8 additions & 20 deletions docs/Reference/applications/list.md
Original file line number Diff line number Diff line change
@@ -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
```
Original file line number Diff line number Diff line change
@@ -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:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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 [<name>] [options]
quix applications variables delete [<name>] [options]
```

**Arguments:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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 <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 <workspace-id>` : The environment to use if your Sdk broker configuration is set to Quix Cloud
- `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
- `--directory <directory>` : Base directory (defaults to current directory)
- `--reset` : Removes all the values of existing env variables and adds them from the app.yaml file [default: False]

- `--reset` : Removes all the values of existing env variables and adds them from the app.yaml file [default: False]

Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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 <env-file-name>` : Set the name of the environment file [default: .env]
- `--directory <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]

Loading

0 comments on commit caeec17

Please sign in to comment.