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

chore(backport release-1.2): docs: cli instructions doc #3380

Merged
merged 1 commit into from
Jan 27, 2025
Merged
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 6 additions & 25 deletions docs/docs/60-new-docs/20-quickstart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -511,33 +511,14 @@ the previous section.

<TabItem value="kargo-cli" label="Using the Kargo CLI">

Install the Kargo CLI:
Download the Kargo CLI for your operating system and CPU architecture from
the [Kargo Dashboard's Downloads page](https://localhost:31444/downloads):

<Tabs groupId="os">
<TabItem value="general" label="Mac, Linux, or WSL" default>
![CLI Tab in Kargo UI](./img/cli-installation.png)

```shell
arch=$(uname -m)
[ "$arch" = "x86_64" ] && arch=amd64
curl -L -o kargo https://github.com/akuity/kargo/releases/latest/download/kargo-"$(uname -s | tr '[:upper:]' '[:lower:]')-${arch}"
chmod +x kargo
```

Then move `kargo` to a location in your file system that is included in the
value of your `PATH` environment variable.

</TabItem>
<TabItem value="windows" label="Windows Powershell">

```shell
Invoke-WebRequest -URI https://github.com/akuity/kargo/releases/latest/download/kargo-windows-amd64.exe -OutFile kargo.exe
```

Then move `kargo.exe` to a location in your file system that is included in the value
of your `PATH` environment variable.

</TabItem>
</Tabs>
Rename the downloaded binary to `kargo` (or `kargo.exe` for Windows) and
move it to a location in your file system that is included in the value of
your `PATH` environment variable.

Log in:

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
sidebar_label: Installing the CLI
---

# Installing the Kargo CLI

Although its web-based UI provides the best user experience, Kargo also offers a
command line interface (CLI) for users who may prefer it.

To install:

1. Download the CLI binary.

The easiest method of downloading the binary is by selecting the
<Hlt>CLI</Hlt> tab from the left navbar of the UI. There, you can select
the appropriate binary for your operating system and CPU architecture.

CLI downloads offered at this location will automatically match the version
of your Kargo API server for optimum compatibility.

Your downloaded binary will be suffixed with your OS and CPU architecture
(e.g. `kargo-darwin-arm64`), so be sure to rename it to simply `kargo` (or
`kargo.exe` for Windows).

![CLI Tab in Kargo UI](./img/cli-installation.png)

If you prefer, the following commands will download the latest version of
the CLI for your specific OS and CPU architecture and will also rename the
binary to `kargo` (or `kargo.exe` on Windows.)

<Tabs groupId="os">
<TabItem value="mac-linux-wsl" label="Mac, Linux, or WSL" default>

```shell
arch=$(uname -m)
[ "$arch" = "x86_64" ] && arch=amd64
curl -L -o kargo https://github.com/akuity/kargo/releases/latest/download/kargo-"$(uname -s | tr '[:upper:]' '[:lower:]')-${arch}"
chmod +x kargo
```

</TabItem>
<TabItem value="windows" label="Windows Powershell">

```shell
Invoke-WebRequest -URI https://github.com/akuity/kargo/releases/latest/download/kargo-windows-amd64.exe -OutFile kargo.exe
```

</TabItem>
</Tabs>

1. Regardless of your chosen download method, complete the installation by
moving the binary to a location in your file system that is included in the
value of your `PATH` environment variable.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading