forked from viamrobotics/rdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update CLI readme to include installation methods (viamrobotics#3408)
- Loading branch information
1 parent
2a1ed09
commit bbd794b
Showing
1 changed file
with
32 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,39 @@ | ||
## [EXPERIMENTAL] Viam Command Line Interface | ||
|
||
This is an experimental feature, so things may change without notice. | ||
This is an experimental feature, so things may change without notice. All feedback on the cli is greatly appreciated. | ||
|
||
Install with `go build -o ~/go/bin/viam cli/viam/main.go` | ||
|
||
### Getting Started | ||
Enter `viam login` and follow instructions to authenticate. | ||
|
||
### Installation | ||
|
||
With brew (macOS & linux amd64): | ||
```sh | ||
brew tap viamrobotics/brews | ||
brew install viam | ||
``` | ||
As a binary (linux amd64): | ||
```sh | ||
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 | ||
``` | ||
|
||
As a binary (linux arm64): | ||
```sh | ||
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 | ||
``` | ||
|
||
From source (you must [install go](https://go.dev/doc/install) first): | ||
```sh | ||
go install go.viam.com/rdk/cli/viam@latest | ||
# add go binaries to your path (if you haven't already) | ||
echo 'export PATH="$HOME/go/bin:$PATH"' >> ~/.bashrc | ||
``` | ||
|
||
### Development | ||
Building (you must [install go](https://go.dev/doc/install) first): | ||
```sh | ||
go build -o ~/go/bin/viam cli/viam/main.go | ||
``` |