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

DOCS-1116: Update viam CLI brew install #1820

Merged

Conversation

andf-viam
Copy link
Contributor

@andf-viam andf-viam commented Sep 13, 2023

Removed both macOS arch direct download steps in favor of new brew install.

  • Also updated "To later update ..." sentence with macOS (brew)-specific instruction.
  • Left Linux instructions as-are (but simplified uname -m tip, since it now only applies to a subset of installation paths)

Staging

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 13, 2023
@viambot
Copy link
Member

viambot commented Sep 13, 2023

Overall readability score: 54.7 (🟢 +0)

File Readability
CLI.md 58.84 (🟢 +0.76)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
CLI.md 58.84 42.51 10.06 13.9 12.18 6.3
  🟢 +0.76 🟢 +0.3 🟢 +0.11 🟢 +0.3 🟢 +0.06 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.7 46.18 10.87 13.31 11.82 7.77
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

Copy link
Member

@abe-winter abe-winter left a comment

Choose a reason for hiding this comment

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

lgtm

{{% 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" %}}
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!

@@ -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 viamrobotics/brews/viam`.
Copy link
Member

Choose a reason for hiding this comment

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

if they went through brew tap above, can also do brew upgrade viam, but this works too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point!

@viambot
Copy link
Member

viambot commented Sep 13, 2023

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/bbe4be370ef123ac8412bf2b52f052832dae6c9f/public

@andf-viam andf-viam merged commit c0a7833 into viamrobotics:main Sep 13, 2023
6 checks passed
@andf-viam andf-viam deleted the DOCS-1116-update-cli-install-brew branch September 13, 2023 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants