Skip to content

Commit

Permalink
Update rad CLI documentation (#686)
Browse files Browse the repository at this point in the history
* Autogenerate rad CLI reference docs

* Spellcheck

---------

Co-authored-by: rad-ci-bot <[email protected]>
Co-authored-by: Aaron Crawfis <[email protected]>
  • Loading branch information
3 people authored Aug 16, 2023
1 parent 705ff07 commit c902970
Show file tree
Hide file tree
Showing 63 changed files with 3,343 additions and 1 deletion.
8 changes: 7 additions & 1 deletion .github/config/en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,12 @@ rabbitMQ
azureCache
listKeys
primaryKey
mygroup
Kubeconfig
unregister
Unregisters
br
myregistry
GCP
Fargate
untyped
untyped
45 changes: 45 additions & 0 deletions docs/content/reference/cli/rad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
type: docs
date: 2023-08-15T23:32:25Z
title: "rad CLI reference"
linkTitle: "rad"
slug: rad
url: /reference/cli/rad/
description: "Details on the rad Radius CLI command"
---
## rad

Radius CLI

### Synopsis

Radius CLI

### Options

```
--config string config file (default "$HOME/.rad/config.yaml")
-h, --help help for rad
-o, --output string output format (supported formats are json, table) (default "table")
```

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications
* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts
* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation.
* [rad debug-logs]({{< ref rad_debug-logs.md >}}) - Capture logs from Radius control plane for debugging and diagnostics.
* [rad deploy]({{< ref rad_deploy.md >}}) - Deploy a template
* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments
* [rad group]({{< ref rad_group.md >}}) - Manage resource groups
* [rad init]({{< ref rad_init.md >}}) - Initialize Radius
* [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform
* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes
* [rad resource]({{< ref rad_resource.md >}}) - Manage resources
* [rad run]({{< ref rad_run.md >}}) - Run an application
* [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform
* [rad version]({{< ref rad_version.md >}}) - Prints the versions of the rad cli
* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces

###### Auto generated by spf13/cobra on 15-Aug-2023
41 changes: 41 additions & 0 deletions docs/content/reference/cli/rad_application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
type: docs
date: 2023-08-15T23:32:25Z
title: "rad application CLI reference"
linkTitle: "rad application"
slug: rad_application
url: /reference/cli/rad_application/
description: "Details on the rad application Radius CLI command"
---
## rad application

Manage Radius applications

### Synopsis

Manage Radius applications

### Options

```
-h, --help help for application
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
-o, --output string output format (supported formats are json, table) (default "table")
```

### SEE ALSO

* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad application connections]({{< ref rad_application_connections.md >}}) - Shows the connections for an application.
* [rad application delete]({{< ref rad_application_delete.md >}}) - Delete Radius application
* [rad application list]({{< ref rad_application_list.md >}}) - List Radius applications
* [rad application show]({{< ref rad_application_show.md >}}) - Show Radius application details
* [rad application status]({{< ref rad_application_status.md >}}) - Show Radius application status
* [rad application switch]({{< ref rad_application_switch.md >}}) - Switch the default Radius application

###### Auto generated by spf13/cobra on 15-Aug-2023
54 changes: 54 additions & 0 deletions docs/content/reference/cli/rad_application_connections.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
type: docs
date: 2023-08-15T23:32:25Z
title: "rad application connections CLI reference"
linkTitle: "rad application connections"
slug: rad_application_connections
url: /reference/cli/rad_application_connections/
description: "Details on the rad application connections Radius CLI command"
---
## rad application connections

Shows the connections for an application.

### Synopsis

Shows the connections for an application

```
rad application connections [flags]
```

### Examples

```
# Show connections for current application
rad app connections
# Show connections for specified application
rad app connections my-application
```

### Options

```
-a, --application string The application name
-e, --environment string The environment name
-g, --group string The resource group name
-h, --help help for connections
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
-o, --output string output format (supported formats are json, table) (default "table")
```

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications

###### Auto generated by spf13/cobra on 15-Aug-2023
61 changes: 61 additions & 0 deletions docs/content/reference/cli/rad_application_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
type: docs
date: 2023-08-15T23:32:25Z
title: "rad application delete CLI reference"
linkTitle: "rad application delete"
slug: rad_application_delete
url: /reference/cli/rad_application_delete/
description: "Details on the rad application delete Radius CLI command"
---
## rad application delete

Delete Radius application

### Synopsis

Delete the specified Radius application deployed in the default environment

```
rad application delete [flags]
```

### Examples

```
# Delete current application
rad app delete
# Delete current application and bypass confirmation prompt
rad app delete --yes
# Delete specified application
rad app delete my-app
# Delete specified application in a specified resource group
rad app delete my-app --group my-group
```

### Options

```
-a, --application string The application name
-g, --group string The resource group name
-h, --help help for delete
-w, --workspace string The workspace name
-y, --yes The confirmation flag
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
-o, --output string output format (supported formats are json, table) (default "table")
```

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications

###### Auto generated by spf13/cobra on 15-Aug-2023
53 changes: 53 additions & 0 deletions docs/content/reference/cli/rad_application_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
type: docs
date: 2023-08-15T23:32:25Z
title: "rad application list CLI reference"
linkTitle: "rad application list"
slug: rad_application_list
url: /reference/cli/rad_application_list/
description: "Details on the rad application list Radius CLI command"
---
## rad application list

List Radius applications

### Synopsis

Lists Radius applications deployed in the resource group associated with the default environment

```
rad application list [flags]
```

### Examples

```
# List applications
rad app list
# List applications in a specific resource group
rad app list --group my-group
```

### Options

```
-g, --group string The resource group name
-h, --help help for list
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications

###### Auto generated by spf13/cobra on 15-Aug-2023
57 changes: 57 additions & 0 deletions docs/content/reference/cli/rad_application_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
type: docs
date: 2023-08-15T23:32:25Z
title: "rad application show CLI reference"
linkTitle: "rad application show"
slug: rad_application_show
url: /reference/cli/rad_application_show/
description: "Details on the rad application show Radius CLI command"
---
## rad application show

Show Radius application details

### Synopsis

Show Radius application details. Shows the user's default application (if configured) by default.

```
rad application show [flags]
```

### Examples

```
# Show current application
rad app show
# Show specified application
rad app show my-app
# Show specified application in a specified resource group
rad app show my-app --group my-group
```

### Options

```
-a, --application string The application 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")
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications

###### Auto generated by spf13/cobra on 15-Aug-2023
57 changes: 57 additions & 0 deletions docs/content/reference/cli/rad_application_status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
type: docs
date: 2023-08-15T23:32:25Z
title: "rad application status CLI reference"
linkTitle: "rad application status"
slug: rad_application_status
url: /reference/cli/rad_application_status/
description: "Details on the rad application status Radius CLI command"
---
## rad application status

Show Radius application status

### Synopsis

Show Radius application status, such as public endpoints and resource count. Shows details for the user's default application (if configured) by default.

```
rad application status [flags]
```

### Examples

```
# Show status of current application
rad app status
# Show status of specified application
rad app status my-app
# Show status of specified application in a specified resource group
rad app status my-app --group my-group
```

### Options

```
-a, --application string The application name
-g, --group string The resource group name
-h, --help help for status
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications

###### Auto generated by spf13/cobra on 15-Aug-2023
Loading

0 comments on commit c902970

Please sign in to comment.