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

docs: add 'how to install' to argo-cli #9412

Closed
wants to merge 1 commit into from
Closed
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
14 changes: 14 additions & 0 deletions docs/walk-through/argo-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

In case you want to follow along with this walk-through, here's a quick overview of the most useful argo command line interface (CLI) commands.

## Install the Argo CLI tool

You may obtain [the latest release from the releases page](https://github.com/argoproj/argo-workflows/releases/latest).

On MacOS you may also use homebrew to install the tool:

```sh
brew install argo
```

## Quick start with Argo CLI

```bash
argo submit hello-world.yaml # submit a workflow spec to Kubernetes
argo list # list current workflows
Expand All @@ -10,6 +22,8 @@ argo logs hello-world-xxx # print the logs from a workflow
argo delete hello-world-xxx # delete workflow
```

## How to use kubectl directly

You can also run workflow specs directly using `kubectl` but the Argo CLI provides syntax checking, nicer output, and requires less typing.

```bash
Expand Down