Skip to content

Commit da42b62

Browse files
committed
updated docs to rename the binary per the os system you are on
Issue: [16700]
1 parent fe46050 commit da42b62

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/content/_index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,19 @@ The `kubectl-pgo` binary is available either through the Crunchy Data [Access Po
2828

2929
## Installing the Client
3030

31-
Once downloaded, move the `kubectl-pgo` binary to `/usr/local/bin` and make it executable by running
32-
the following commands:
31+
### Linux or Mac
32+
33+
If you downloaded the Linux binary rename the binary from `kubectl-pgo-linux-amd64` to `kubectl-pgo` or if you download the Mac binary rename the binary from `kubectl-pgo-darwin-amd64` to `kubectl-pgo` then move the `kubectl-pgo` binary to `/usr/local/bin` and make it executable by running the following commands:
3334

3435
```
3536
sudo mv /PATH/TO/kubectl-pgo /usr/local/bin/kubectl-pgo
3637
sudo chmod +x /usr/local/bin/kubectl-pgo
3738
```
3839

40+
### Windows
41+
42+
If you downloaded the Windows binary rename `kubectl-pgo-windows-386` to `kubectl-pgo.exe` this allows Windows to recognize the file as an executable. From there open a power shell terminal in the same directory to execute the binary.
43+
3944
## Checking the plugin install
4045

4146
Now that the `kubectl-pgo` binary is installed on your `PATH`, it can be used as a [kubectl plugin][].

0 commit comments

Comments
 (0)