-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating refactored commands docs (#35)
- Loading branch information
1 parent
7067cd1
commit caeec17
Showing
194 changed files
with
972 additions
and
818 deletions.
There are no files selected for viewing
6 changes: 3 additions & 3 deletions
6
...ference/local/applications/convert.gen.md → docs/Reference/applications/convert.gen.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
8 changes: 4 additions & 4 deletions
8
...eference/local/applications/create.gen.md → docs/Reference/applications/create.gen.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
6 changes: 3 additions & 3 deletions
6
...ocal/applications/variables/create.gen.md → ...ence/applications/variables/create.gen.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
...ocal/applications/variables/delete.gen.md → ...ence/applications/variables/delete.gen.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
.../local/applications/variables/edit.gen.md → ...erence/applications/variables/edit.gen.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 19 additions & 19 deletions
38
...ocal/applications/variables/export.gen.md → ...ence/applications/variables/export.gen.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 18 additions & 18 deletions
36
...ocal/applications/variables/import.gen.md → ...ence/applications/variables/import.gen.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] | ||
|
Oops, something went wrong.