diff --git a/docs/docs/60-new-docs/20-quickstart/img/cli-installation.png b/docs/docs/60-new-docs/20-quickstart/img/cli-installation.png new file mode 100644 index 000000000..36fa105ee Binary files /dev/null and b/docs/docs/60-new-docs/20-quickstart/img/cli-installation.png differ diff --git a/docs/docs/60-new-docs/20-quickstart/index.md b/docs/docs/60-new-docs/20-quickstart/index.md index 3814bd10c..1e19b8998 100644 --- a/docs/docs/60-new-docs/20-quickstart/index.md +++ b/docs/docs/60-new-docs/20-quickstart/index.md @@ -511,33 +511,14 @@ the previous section. - 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): - - + ![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. - - - - - ```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. - - - + 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: diff --git a/docs/docs/60-new-docs/50-user-guide/20-how-to-guides/05-installing-kargo-cli.md b/docs/docs/60-new-docs/50-user-guide/20-how-to-guides/05-installing-kargo-cli.md new file mode 100644 index 000000000..c9a181514 --- /dev/null +++ b/docs/docs/60-new-docs/50-user-guide/20-how-to-guides/05-installing-kargo-cli.md @@ -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 + CLI 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.) + + + + + ```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 + ``` + + + + + ```shell + Invoke-WebRequest -URI https://github.com/akuity/kargo/releases/latest/download/kargo-windows-amd64.exe -OutFile kargo.exe + ``` + + + + +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. \ No newline at end of file diff --git a/docs/docs/60-new-docs/50-user-guide/20-how-to-guides/img/cli-installation.png b/docs/docs/60-new-docs/50-user-guide/20-how-to-guides/img/cli-installation.png new file mode 100644 index 000000000..36fa105ee Binary files /dev/null and b/docs/docs/60-new-docs/50-user-guide/20-how-to-guides/img/cli-installation.png differ