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.

Sign up for GitHub

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

improved CLI installation instructions in quickstart #839

Merged
merged 5 commits into from
Sep 25, 2023
Merged

improved CLI installation instructions in quickstart #839

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0588c8d
improved CLI installation instructions in quickstart
jaimin001 Sep 23, 2023
13e12fc
Update docs/docs/20-quickstart.mdx
jaimin001 Sep 25, 2023
625a4b9
Merge branch 'main' into docs/quickstart-cli
jaimin001 Sep 25, 2023
c319191
Update docs/docs/20-quickstart.mdx
jaimin001 Sep 25, 2023
1a78c81
Update docs/docs/20-quickstart.mdx
morey-tech Sep 25, 2023
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
9 changes: 8 additions & 1 deletion docs/docs/20-quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,14 @@ This guide presents a basic introduction to Kargo. Together, we will:
* kind: v0.17.0
* k3d: v5.4.9
* [Helm](https://helm.sh/docs/): These instructions were tested with v3.11.2.
* The `kargo` CLI: Download it from [the releases page](https://github.com/akuity/kargo/releases/latest).
* The `kargo` CLI: To install the kargo CLI, follow these steps.
morey-tech marked this conversation as resolved.
Show resolved Hide resolved

1. Visit [the releases page](https://github.com/akuity/kargo/releases/latest) of the Kargo GitHub repository.
2. Download the appropriate release package for your operating system (e.g., `kargo-linux-amd64` for Linux).
3. Extract the contents of the downloaded package to a directory of your choice.
jaimin001 marked this conversation as resolved.
Show resolved Hide resolved
4. Add the directory containing the `kargo` executable to your system's `PATH` environment variable.
jaimin001 marked this conversation as resolved.
Show resolved Hide resolved
Comment on lines +32 to +33
Copy link
Contributor

Choose a reason for hiding this comment

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

Addressing @krancour's comment. Nothing to extract, instead instruct to move binary to a bin directory

Suggested change
3. Extract the contents of the downloaded package to a directory of your choice.
4. Add the directory containing the `kargo` executable to your system's `PATH` environment variable.
3. Move the binary to a directory of your choice (e.g. for Linux, consider `/usr/local/bin/`).
4. Add the directory containing the `kargo` executable to your system's `PATH` environment variable.

Copy link
Member

Choose a reason for hiding this comment

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

This suggested change didn't get merged.


After completing these steps, you should be able to run the `kargo` command in your terminal to interact with Kargo.

### Starting a Local Cluster

Expand Down