Skip to content

Commit

Permalink
Add Homebrew Formula (#4880)
Browse files Browse the repository at this point in the history
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>
  • Loading branch information
peaceiris authored and khanhtc1202 committed Apr 22, 2024
1 parent 8983e17 commit d833be1
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 4 deletions.
6 changes: 6 additions & 0 deletions docs/content/en/docs-dev/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ asdf plugin add pipectl && asdf install pipectl latest && asdf global pipectl la
aqua g -i pipe-cd/pipecd/pipectl && aqua i
```

##### Method 4: [Homebrew](https://brew.sh/) Supported Installation

```console
brew install pipe-cd/tap/pipectl
```

#### 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
22 changes: 20 additions & 2 deletions docs/content/en/docs-dev/user-guide/command-line-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,24 @@ The Pipectl command-line tool can be installed using one of the following method
pipectl version
```

### Using [Homebrew](https://brew.sh/)

1. Add the `pipe-cd/tap` and fetch new formulae from GitHub.
```console
brew tap pipe-cd/tap
brew update
```

2. Install pipectl.
```console
brew install pipectl
```

3. Test to ensure the version you installed is up-to-date.
```console
pipectl version
```

### Run in Docker container

We are storing every version of docker image for pipectl on Google Cloud Container Registry.
Expand All @@ -102,7 +120,7 @@ There are two kinds of key role: `READ_ONLY` and `READ_WRITE`. Depending on the
Adding a new API key from Settings tab
</p>
When executing a command of pipectl you have to specify either a string of API key via `--api-key` flag or a path to the API key file via `--api-key-file` flag.
When executing a command of pipectl you have to specify either a string of API key via `--api-key` flag or a path to the API key file via `--api-key-file` flag.
## Usage
Expand Down Expand Up @@ -338,7 +356,7 @@ Note: The docs for pipectl available command is maybe outdated, we suggest users
Generate an app.pipecd.yaml interactively:

``` console
$ pipectl init
$ pipectl init
Which platform? Enter the number [0]Kubernetes [1]ECS: 1
Name of the application: myApp
...
Expand Down
6 changes: 6 additions & 0 deletions docs/content/en/docs-v0.47.x/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ asdf plugin add pipectl && asdf install pipectl latest && asdf global pipectl la
aqua g -i pipe-cd/pipecd/pipectl && aqua i
```

##### Method 4: [Homebrew](https://brew.sh/) Supported Installation

```console
brew install pipe-cd/tap/pipectl
```

#### 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
22 changes: 20 additions & 2 deletions docs/content/en/docs-v0.47.x/user-guide/command-line-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,24 @@ The Pipectl command-line tool can be installed using one of the following method
pipectl version
```

### Using [Homebrew](https://brew.sh/)

1. Add the `pipe-cd/tap` and fetch new formulae from GitHub.
```console
brew tap pipe-cd/tap
brew update
```

2. Install pipectl.
```console
brew install pipectl
```

3. Test to ensure the version you installed is up-to-date.
```console
pipectl version
```

### Run in Docker container

We are storing every version of docker image for pipectl on Google Cloud Container Registry.
Expand All @@ -102,7 +120,7 @@ There are two kinds of key role: `READ_ONLY` and `READ_WRITE`. Depending on the
Adding a new API key from Settings tab
</p>
When executing a command of pipectl you have to specify either a string of API key via `--api-key` flag or a path to the API key file via `--api-key-file` flag.
When executing a command of pipectl you have to specify either a string of API key via `--api-key` flag or a path to the API key file via `--api-key-file` flag.
## Usage
Expand Down Expand Up @@ -338,7 +356,7 @@ Note: The docs for pipectl available command is maybe outdated, we suggest users
Generate an app.pipecd.yaml interactively:

``` console
$ pipectl init
$ pipectl init
Which platform? Enter the number [0]Kubernetes [1]ECS: 1
Name of the application: myApp
...
Expand Down

0 comments on commit d833be1

Please sign in to comment.