Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create rad overview page #781

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/content/guides/deploy-apps/rad-cli/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "rad CLI"
linkTitle: "rad CLI"
description: "Documentation on the rad CLI"
weight: 100
---
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: docs
title: "How-To: Install the rad CLI"
linkTitle: "Install rad CLI"
description: "Learn how to install the rad CLI on your local machine"
weight: 100
weight: 200
categories: "How-To"
tags: ["rad CLI", "Bicep"]
---
Expand Down
90 changes: 90 additions & 0 deletions docs/content/guides/deploy-apps/rad-cli/overview/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
type: docs
title: "Overview: rad CLI"
linkTitle: "Overview"
description: "Learn about the rad CLI and how to interact with Radius from your local machine"
weight: 100
categories: "Overview"
tags: ["rad CLI"]
---

The rad CLI is a command line interface that allows you to interact with Radius from your local machine. It is the primary way to interact with Radius and is used to create, deploy, and manage your applications, environments, and resources.

```bash
$ rad
Radius CLI

Usage:
rad [command]

Available Commands:
application Manage Radius applications
bicep Manage bicep compiler
completion Generates shell completion scripts
credential Manage cloud provider credential for a Radius installation.
debug-logs Capture logs from Radius control plane for debugging and diagnostics.
deploy Deploy a template
env Manage Radius environments
group Manage resource groups
help Help about any command
init Initialize Radius
install Installs Radius for a given platform
recipe Manage recipes
resource Manage resources
run Run an application
uninstall Uninstall Radius for a specific platform
version Prints the versions of the rad cli
workspace Manage workspaces
```

## Installation

The rad CLI is distributed as a single binary that can be installed on Linux, macOS, and Windows. Visit the [installation guide]({{< ref howto-rad-cli >}}) to learn how to install the rad CLI on your machine.

{{< button text="Install rad CLI" page="howto-rad-cli" >}}

### Binary location

{{< tabs "macOS/Linux/WSL" "Windows" >}}

{{% codetab %}}
By default, the rad CLI installation script installs the rad CLI to `/usr/local/bin/rad`

If you would like to install the rad CLI to a different path, you can specify the path with the `RADIUS_INSTALL_DIR` environment variable:

```bash
# Install to home directory
export RADIUS_INSTALL_DIR=~/
```

{{% /codetab %}}

{{% codetab %}}
By default, the rad CLI installation script installs the rad CLI to `%LOCALAPPDATA%\radius\rad.exe`

{{% /codetab %}}

{{< /tabs >}}

### Configuration location

The rad CLI stores workspaces, the rad-Bicep compiler, and other configuration under the `rad` directory.

{{< tabs "macOS/Linux/WSL" "Windows" >}}

{{% codetab %}}
The rad CLI stores configuration under `~/.rad`
{{% /codetab %}}

{{% codetab %}}
The rad CLI stores configuration under `%USERPROFILE%\rad`
{{% /codetab %}}

{{< /tabs >}}


## Reference documentation

Visit the [reference documentation]({{< ref "/reference/cli" >}}) to learn more about the rad CLI and its commands.

{{< button text="Reference docs" page="/reference/cli" >}}