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.

Sign up for GitHub

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

DOCS-1116: Update viam CLI brew install #1820

Merged
merged 3 commits into from
Sep 13, 2023
Merged

DOCS-1116: Update viam CLI brew install #1820

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3996196
DOCS-1116: Update viam CLI brew install
andf-viam Sep 13, 2023
08459e3
simplify uname tip
andf-viam Sep 13, 2023
bbe4be3
abe feedback
andf-viam Sep 13, 2023
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
38 changes: 13 additions & 25 deletions docs/manage/CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,48 +29,35 @@ viam.component.servo.v1.ServoService.MoveRequest

You can download the Viam CLI executable using one of the options below.
Select the tab for your platform and architecture.

{{% alert title="Tip" color="tip" %}}
You can use the `uname -m` command to determine your system architecture.
{{% /alert %}}
If you are on Linux, you can use the `uname -m` command to determine your system architecture.

{{< tabs >}}
{{% tab name="Linux aarch64" %}}

To download the Viam CLI on a Linux computer with the `aarch64` architecture, run the following commands:

```{class="command-line" data-prompt="$"}
sudo curl -o /usr/local/bin/viam https://storage.googleapis.com/packages.viam.com/apps/viam-cli/viam-cli-stable-linux-arm64
sudo chmod a+rx /usr/local/bin/viam
```

{{% /tab %}}
{{% tab name="Linux x86_64" %}}
{{% tab name="macOS" %}}

To download the Viam CLI on a Linux computer with the `amd64` (Intel `x86_64`) architecture, run the following commands:
To download the Viam CLI on a macOS computer, run the following commands:

```{class="command-line" data-prompt="$"}
sudo curl -o /usr/local/bin/viam https://storage.googleapis.com/packages.viam.com/apps/viam-cli/viam-cli-stable-linux-amd64
sudo chmod a+rx /usr/local/bin/viam
brew tap viamrobotics/brews
brew install viam
```

{{% /tab %}}
{{% tab name="macOS arm64" %}}
{{% tab name="Linux aarch64" %}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of scope for PR, but should macos be first here? (on the assumption it's the most common case)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, works for me!


To download the Viam CLI on a macOS computer with the `arm64` (Apple Silicon) architecture, run the following commands:
To download the Viam CLI on a Linux computer with the `aarch64` architecture, run the following commands:

```{class="command-line" data-prompt="$"}
sudo curl -o /usr/local/bin/viam https://storage.googleapis.com/packages.viam.com/apps/viam-cli/viam-cli-stable-darwin-arm64
sudo curl -o /usr/local/bin/viam https://storage.googleapis.com/packages.viam.com/apps/viam-cli/viam-cli-stable-linux-arm64
sudo chmod a+rx /usr/local/bin/viam
```

{{% /tab %}}
{{% tab name="macOS x86_64" %}}
{{% tab name="Linux x86_64" %}}

To download the Viam CLI on a macOS computer with the `amd64` (Intel `x86_64`) architecture, run the following commands:
To download the Viam CLI on a Linux computer with the `amd64` (Intel `x86_64`) architecture, run the following commands:

```{class="command-line" data-prompt="$"}
sudo curl -o /usr/local/bin/viam https://storage.googleapis.com/packages.viam.com/apps/viam-cli/viam-cli-stable-darwin-amd64
sudo curl -o /usr/local/bin/viam https://storage.googleapis.com/packages.viam.com/apps/viam-cli/viam-cli-stable-linux-amd64
sudo chmod a+rx /usr/local/bin/viam
```

Expand All @@ -95,7 +82,8 @@ echo 'export PATH="$HOME/go/bin:$PATH"' >> ~/.bashrc
{{% /tab %}}
{{< /tabs >}}

To later update the Viam CLI tool, you can use the steps above to reinstall the latest version.
To later update the Viam CLI tool on Linux, use the steps above to reinstall the latest version.
to later update the Viam CLI tool on macOS, run `brew upgrade viam`.

## Authenticate

Expand Down