Skip to content

Commit

Permalink
Add document pipectl install method using asdf (#4185)
Browse files Browse the repository at this point in the history
  • Loading branch information
funera1 authored Feb 14, 2023
1 parent 5bce4e3 commit 02fd9ad
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/content/en/docs-dev/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Note: It's not required to install the PipeCD control plane to the cluster where

#### 1.1. Installing PipeCD client

##### Method 1: Official Installation
The official PipeCD client named `pipectl` can be installed using the following command

``` console
Expand All @@ -37,6 +38,12 @@ You can also move the pipectl binary to the $PATH for later use
sudo mv ./pipectl /usr/local/bin/pipectl
```

##### Method 2: [Asdf](https://asdf-vm.com/) Supported Installation

```console
asdf plugin add pipectl && asdf install pipectl latest && asdf global pipectl latest
```

#### 1.2. Installing PipeCD's components

We can simply use __pipectl quickstart__ command to start the PipeCD installation process and follow the instruction
Expand Down
23 changes: 23 additions & 0 deletions docs/content/en/docs-dev/user-guide/command-line-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,29 @@ You can use pipectl to add and sync applications, wait for a deployment status.
pipectl version
```

### [Asdf](https://asdf-vm.com/)

1. Add pipectl plugin to asdf. (If you have not yet `asdf add plugin add pipectl`.)
```console
asdf add plugin pipectl
```

2. Install pipectl. Available versions are [here](https://github.com/pipe-cd/pipecd/releases).
```console
asdf install pipectl {VERSION}
```

3. Set a version.
```console
asdf global pipectl {VERSION}
```

4. Test to ensure the version you installed is up-to-date.

``` console
pipectl version
```

### Docker
We are storing every version of docker image for pipectl on Google Cloud Container Registry.
Available versions are [here](https://github.com/pipe-cd/pipecd/releases).
Expand Down

0 comments on commit 02fd9ad

Please sign in to comment.