Skip to content

Commit

Permalink
Autogenerate rad CLI reference docs (#739)
Browse files Browse the repository at this point in the history
Co-authored-by: rad-ci-bot <[email protected]>
  • Loading branch information
rad-ci-bot and rad-ci-bot authored Sep 7, 2023
1 parent 967929f commit 4ad0ae8
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions docs/content/reference/cli/rad_recipe_register.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ rad recipe register [recipe-name] [flags]
```
# Add a recipe to an environment
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Datastores/mongoDatabases
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --resource-type Applications.Datastores/mongoDatabases
# Specify a parameter
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Datastores/mongoDatabases --parameters throughput=400
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --resource-type Applications.Datastores/mongoDatabases --parameters throughput=400
# specify multiple parameters using a JSON parameter file
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Datastores/mongoDatabases --parameters @myfile.json
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --resource-type Applications.Datastores/mongoDatabases --parameters @myfile.json
```

Expand All @@ -44,9 +44,9 @@ rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --te
-e, --environment string The environment name
-g, --group string The resource group name
-h, --help help for register
--link-type string specify the type of the portable resource this recipe can be consumed by
-o, --output string output format (supported formats are json, table) (default "table")
-p, --parameters stringArray Specify parameters for the deployment
--resource-type string specify the type of the portable resource this recipe can be consumed by
--template-kind string specify the kind for the template provided by the recipe.
--template-path string specify the path to the template provided by the recipe.
--template-version string specify the version for the terraform module.
Expand Down
12 changes: 6 additions & 6 deletions docs/content/reference/cli/rad_recipe_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ rad recipe show redis-dev --group dev --environment dev
### Options

```
-e, --environment string The environment name
-g, --group string The resource group name
-h, --help help for show
--link-type string Specify the type of the link this recipe can be consumed by
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
-e, --environment string The environment name
-g, --group string The resource group name
-h, --help help for show
-o, --output string output format (supported formats are json, table) (default "table")
--resource-type string Specify the type of the portable resource this recipe can be consumed by
-w, --workspace string The workspace name
```

### Options inherited from parent commands
Expand Down
12 changes: 6 additions & 6 deletions docs/content/reference/cli/rad_recipe_unregister.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ rad recipe unregister cosmosdb
### Options

```
-e, --environment string The environment name
-g, --group string The resource group name
-h, --help help for unregister
--link-type string Specify the type of the link this recipe can be consumed by
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
-e, --environment string The environment name
-g, --group string The resource group name
-h, --help help for unregister
-o, --output string output format (supported formats are json, table) (default "table")
--resource-type string Specify the type of the portable resource this recipe can be consumed by
-w, --workspace string The workspace name
```

### Options inherited from parent commands
Expand Down

0 comments on commit 4ad0ae8

Please sign in to comment.