Skip to content
Merged
Show file tree
Hide file tree
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
163 changes: 86 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Download the latest binary executable for your operating system.
brew install tektoncd-cli
```

- Use [released tarball](https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Darwin_all.tar.gz)
- Use [released tarball](https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Darwin_all.tar.gz)

```shell
# Get the tar.xz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Darwin_all.tar.gz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Darwin_all.tar.gz
# Extract tkn to your PATH (e.g. /usr/local/bin)
sudo tar xvzf tkn_0.42.0_Darwin_all.tar.gz -C /usr/local/bin tkn
sudo tar xvzf tkn_0.43.0_Darwin_all.tar.gz -C /usr/local/bin tkn
```

### Windows
Expand All @@ -39,17 +39,18 @@ choco install tektoncd-cli --confirm
```

- Use [Scoop](https://scoop.sh)

```powershell
scoop install tektoncd-cli
```

- Use [Powershell](https://docs.microsoft.com/en-us/powershell) [released zip](https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Windows_x86_64.zip)
- Use [Powershell](https://docs.microsoft.com/en-us/powershell) [released zip](https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Windows_x86_64.zip)

```powershell
#Create directory
New-Item -Path "$HOME/tektoncd/cli" -Type Directory
# Download file
Start-BitsTransfer -Source https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Windows_x86_64.zip -Destination "$HOME/tektoncd/cli/."
Start-BitsTransfer -Source https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Windows_x86_64.zip -Destination "$HOME/tektoncd/cli/."
# Uncompress zip file
Expand-Archive $HOME/tektoncd/cli/*.zip -DestinationPath C:\Users\Developer\tektoncd\cli\.
#Add to Windows `Environment Variables`
Expand All @@ -58,90 +59,90 @@ Expand-Archive $HOME/tektoncd/cli/*.zip -DestinationPath C:\Users\Developer\tekt

### Linux tarballs

* [Linux AMD 64](https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Linux_x86_64.tar.gz)
- [Linux AMD 64](https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Linux_x86_64.tar.gz)

```shell
# Get the tar.xz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Linux_x86_64.tar.gz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Linux_x86_64.tar.gz
# Extract tkn to your PATH (e.g. /usr/local/bin)
sudo tar xvzf tkn_0.42.0_Linux_x86_64.tar.gz -C /usr/local/bin/ tkn
sudo tar xvzf tkn_0.43.0_Linux_x86_64.tar.gz -C /usr/local/bin/ tkn
```

* [Linux AARCH 64](https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Linux_aarch64.tar.gz)
- [Linux AARCH 64](https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Linux_aarch64.tar.gz)

```shell
# Get the tar.xz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Linux_aarch64.tar.gz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Linux_aarch64.tar.gz
# Extract tkn to your PATH (e.g. /usr/local/bin)
sudo tar xvzf tkn_0.42.0_Linux_aarch64.tar.gz -C /usr/local/bin/ tkn
sudo tar xvzf tkn_0.43.0_Linux_aarch64.tar.gz -C /usr/local/bin/ tkn
```

* [Linux IBM Z](https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Linux_s390x.tar.gz)
- [Linux IBM Z](https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Linux_s390x.tar.gz)

```shell
# Get the tar.gz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Linux_s390x.tar.gz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Linux_s390x.tar.gz
# Extract tkn to your PATH (e.g. /usr/local/bin)
sudo tar xvzf tkn_0.42.0_Linux_s390x.tar.gz -C /usr/local/bin/ tkn
sudo tar xvzf tkn_0.43.0_Linux_s390x.tar.gz -C /usr/local/bin/ tkn
```

* [Linux IBM P](https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Linux_ppc64le.tar.gz)
- [Linux IBM P](https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Linux_ppc64le.tar.gz)

```shell
# Get the tar.gz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Linux_ppc64le.tar.gz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Linux_ppc64le.tar.gz
# Extract tkn to your PATH (e.g. /usr/local/bin)
sudo tar xvzf tkn_0.42.0_Linux_ppc64le.tar.gz -C /usr/local/bin/ tkn
sudo tar xvzf tkn_0.43.0_Linux_ppc64le.tar.gz -C /usr/local/bin/ tkn
```

### Linux RPMs

If you are running on any of the following rpm based distros:
If you are running on any of the following rpm based distros:

* Latest Fedora and the two versions behind.
* Centos Stream
* EPEL
* Latest RHEL
- Latest Fedora and the two versions behind.
- Centos Stream
- EPEL
- Latest RHEL

you would be able to use [@chmouel](https://github.com/chmouel)'s unofficial copr package
repository by running the following commands:
you would be able to use [@chmouel](https://github.com/chmouel)'s unofficial copr package
repository by running the following commands:

```shell
dnf copr enable chmouel/tektoncd-cli
dnf install tektoncd-cli
```
```shell
dnf copr enable chmouel/tektoncd-cli
dnf install tektoncd-cli
```

* [Binary RPM package](https://github.com/tektoncd/cli/releases/download/v0.42.0/tektoncd-cli-0.42.0_Linux-64bit.rpm)
- [Binary RPM package](https://github.com/tektoncd/cli/releases/download/v0.43.0/tektoncd-cli-0.43.0_Linux-64bit.rpm)

On any other RPM based distros, you can install the rpm directly:
On any other RPM based distros, you can install the rpm directly:

```shell
rpm -Uvh https://github.com/tektoncd/cli/releases/download/v0.42.0/tektoncd-cli-0.42.0_Linux-64bit.rpm
```
```shell
rpm -Uvh https://github.com/tektoncd/cli/releases/download/v0.43.0/tektoncd-cli-0.43.0_Linux-64bit.rpm
```

### Linux Debs

* [Ubuntu PPA](https://launchpad.net/~tektoncd/+archive/ubuntu/cli/+packages)
- [Ubuntu PPA](https://launchpad.net/~tektoncd/+archive/ubuntu/cli/+packages)

If you are running on the latest rolling Ubuntu or Debian, you can use the TektonCD CLI PPA:
If you are running on the latest rolling Ubuntu or Debian, you can use the TektonCD CLI PPA:

```shell
sudo apt update;sudo apt install -y gnupg
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 3EFE0E0A2F2F60AA
echo "deb http://ppa.launchpad.net/tektoncd/cli/ubuntu oracular main"|sudo tee /etc/apt/sources.list.d/tektoncd-ubuntu-cli.list
sudo apt update && sudo apt install -y tektoncd-cli
```
```shell
sudo apt update;sudo apt install -y gnupg
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 3EFE0E0A2F2F60AA
echo "deb http://ppa.launchpad.net/tektoncd/cli/ubuntu oracular main"|sudo tee /etc/apt/sources.list.d/tektoncd-ubuntu-cli.list
sudo apt update && sudo apt install -y tektoncd-cli
```

The PPA may work with older releases, but that hasn't been tested.
The PPA may work with older releases, but that hasn't been tested.

* [Binary DEB package](https://github.com/tektoncd/cli/releases/download/v0.42.0/tektoncd-cli-0.42.0_Linux-64bit.deb)
- [Binary DEB package](https://github.com/tektoncd/cli/releases/download/v0.43.0/tektoncd-cli-0.43.0_Linux-64bit.deb)

On any other Debian or Ubuntu based distro, you can simply install the binary package directly with `dpkg`:
On any other Debian or Ubuntu based distro, you can simply install the binary package directly with `dpkg`:

```shell
curl -LO https://github.com/tektoncd/cli/releases/download/v0.42.0/tektoncd-cli-0.42.0_Linux-64bit.deb
dpkg -i tektoncd-cli-0.42.0_Linux-64bit.deb
```
```shell
curl -LO https://github.com/tektoncd/cli/releases/download/v0.43.0/tektoncd-cli-0.43.0_Linux-64bit.deb
dpkg -i tektoncd-cli-0.43.0_Linux-64bit.deb
```

### NixOS/Nix

Expand All @@ -150,6 +151,7 @@ You can install `tektoncd-cli` from [nixpkgs](https://github.com/NixOS/nixpkgs)
```shell
nix-env --install tektoncd-cli
```

### Arch / Manjaro

You can install [`tekton-cli`](https://archlinux.org/packages/extra/x86_64/tekton-cli/) from the official arch package repository :
Expand All @@ -168,53 +170,61 @@ brew install tektoncd-cli

### Source install

If you have [go](https://golang.org/) installed and you want to compile the CLI from source, you can checkout the [Git repository](https://github.com/tektoncd/cli) and run the following commands:
If you have [go](https://golang.org/) installed and you want to compile the CLI from source, you can checkout the [Git repository](https://github.com/tektoncd/cli) and run the following commands:

```shell
make bin/tkn
```
```shell
make bin/tkn
```

This will output the `tkn` binary in `bin/tkn`
This will output the `tkn` binary in `bin/tkn`

### `tkn` as a `kubectl` plugin

`kubectl` will find any binary named `kubectl-*` on your PATH and consider it as a plugin.
After installing tkn, create a link as kubectl-tkn
```shell

```shell
ln -s /usr/local/bin/tkn /usr/local/bin/kubectl-tkn
```
```

For Mac OS X with Homebrew
```shell

```shell
ln -s $(brew --prefix)/opt/tektoncd-cli/bin/tkn /usr/local/bin/kubectl-tkn
```
```

Run the following to confirm tkn is available as a plugin:
```shell

```shell
kubectl plugin list
```
```

You should see the following after running kubectl plugin list if tkn is available as a plugin:
```shell

```shell
/usr/local/bin/kubectl-tkn
```

If the output above is shown, run kubectl-tkn to see the list of available tkn commands to run.

## Useful Commands

The following commands help you understand and effectively use the Tekton CLI:

* `tkn help:` Displays a list of the commands with helpful information.
* [`tkn bundle:`](docs/cmd/tkn_bundle.md) Manage Tekton [bundles](https://github.com/tektoncd/pipeline/blob/main/docs/tekton-bundle-contracts.md)
* [`tkn clustertriggerbinding:`](docs/cmd/tkn_clustertriggerbinding.md) Parent command of the ClusterTriggerBinding command group.
* [`tkn completion:`](docs/cmd/tkn_completion.md) Outputs a BASH, ZSH, Fish or PowerShell completion script for `tkn` to allow command completion with Tab.
* [`tkn customrun:`](docs/cmd/tkn_customrun.md) Parent command of the Customrun command group.
* [`tkn eventlistener:`](docs/cmd/tkn_eventlistener.md) Parent command of the Eventlistener command group.
* [`tkn hub:`](docs/cmd/tkn_hub.md) Search and install Tekton Resources from [Hub](https://hub.tekton.dev)
* [`tkn pipeline:`](docs/cmd/tkn_pipeline.md) Parent command of the Pipeline command group.
* [`tkn pipelinerun:`](docs/cmd/tkn_pipelinerun.md) Parent command of the Pipelinerun command group.
* [`tkn task:`](docs/cmd/tkn_task.md) Parent command of the Task command group.
* [`tkn taskrun:`](docs/cmd/tkn_taskrun.md) Parent command of the Taskrun command group.
* [`tkn triggerbinding:`](docs/cmd/tkn_triggerbinding.md) Parent command of the Triggerbinding command group.
* [`tkn triggertemplate:`](docs/cmd/tkn_triggertemplate.md) Parent command of the Triggertemplate command group.
* [`tkn version:`](docs/cmd/tkn_version.md) Outputs the cli version.
- `tkn help:` Displays a list of the commands with helpful information.
- [`tkn bundle:`](docs/cmd/tkn_bundle.md) Manage Tekton [bundles](https://github.com/tektoncd/pipeline/blob/main/docs/tekton-bundle-contracts.md)
- [`tkn clustertriggerbinding:`](docs/cmd/tkn_clustertriggerbinding.md) Parent command of the ClusterTriggerBinding command group.
- [`tkn completion:`](docs/cmd/tkn_completion.md) Outputs a BASH, ZSH, Fish or PowerShell completion script for `tkn` to allow command completion with Tab.
- [`tkn customrun:`](docs/cmd/tkn_customrun.md) Parent command of the Customrun command group.
- [`tkn eventlistener:`](docs/cmd/tkn_eventlistener.md) Parent command of the Eventlistener command group.
- [`tkn hub:`](docs/cmd/tkn_hub.md) Search and install Tekton Resources from [Hub](https://hub.tekton.dev)
- [`tkn pipeline:`](docs/cmd/tkn_pipeline.md) Parent command of the Pipeline command group.
- [`tkn pipelinerun:`](docs/cmd/tkn_pipelinerun.md) Parent command of the Pipelinerun command group.
- [`tkn task:`](docs/cmd/tkn_task.md) Parent command of the Task command group.
- [`tkn taskrun:`](docs/cmd/tkn_taskrun.md) Parent command of the Taskrun command group.
- [`tkn triggerbinding:`](docs/cmd/tkn_triggerbinding.md) Parent command of the Triggerbinding command group.
- [`tkn triggertemplate:`](docs/cmd/tkn_triggertemplate.md) Parent command of the Triggertemplate command group.
- [`tkn version:`](docs/cmd/tkn_version.md) Outputs the cli version.

For every `tkn` command, you can use `-h` or `--help` flags to display specific help for that command.

Expand All @@ -224,9 +234,9 @@ For many `tkn` commands, color and emojis by default will appear in command
output.

It will only shows if you are in interactive shell with a [standard
input](https://en.wikipedia.org/wiki/Standard_streams#Standard_input_(stdin))
input](<https://en.wikipedia.org/wiki/Standard_streams#Standard_input_(stdin)>)
attached. If you pipe the tkn command or run it in a non interactive way (ie:
from tekton itself in a Task) the coloring and emojis will *always* be disabled.
from tekton itself in a Task) the coloring and emojis will **always** be disabled.

`tkn` offers two approaches for disabling color and emojis from command output.

Expand All @@ -245,7 +255,6 @@ such as in the example below:
tkn taskrun describe --no-color
```


## Want to contribute

We are so excited to have you!
Expand Down
12 changes: 6 additions & 6 deletions choco/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ After running the commands above, `tkn` should be installed. You can run `tkn` t

### Uninstall

Run `choco uninstall tektoncd-cli` to uninstall `tkn`.
Run `choco uninstall tektoncd-cli` to uninstall `tkn`.

### Updating the Package to a New Version

To update this package to a newer version of `tkn`, the following updates should be made:

* Edit the version property in [tektoncd-cli.nuspec](./tektoncd-cli.nuspec#L5) to the latest available version of `tkn`.
* Change the [version in the download url for the Windows `tkn` zip](./tools/chocolateyinstall.ps1#L4) to the latest available version of `tkn`.
* Update the [checksum for the package](./tools/chocolateyinstall.ps1#L11) by getting the sha256 of the zip file. Example: `Get-FileHash '.\tkn_0.42.0_Windows_x86_64.zip'`. The zip can be downloaded using the release download url from GitHub; just remember to change the version numbers in the url: https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Windows_x86_64.zip.
* Run `choco pack` in the `choco` directory to build the package
* Run `choco push` to push the built package and make it available for download (NOTE: You will need permissions to push the package/to be authenticated. Reach out to [@danielhelfand](https://github.com/danielhelfand) for more details.)
- Edit the version property in [tektoncd-cli.nuspec](./tektoncd-cli.nuspec#L5) to the latest available version of `tkn`.
- Change the [version in the download url for the Windows `tkn` zip](./tools/chocolateyinstall.ps1#L4) to the latest available version of `tkn`.
- Update the [checksum for the package](./tools/chocolateyinstall.ps1#L11) by getting the sha256 of the zip file. Example: `Get-FileHash '.\tkn_0.43.0_Windows_x86_64.zip'`. The zip can be downloaded using the release download url from GitHub; just remember to change the version numbers in the url: https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Windows_x86_64.zip.
- Run `choco pack` in the `choco` directory to build the package
- Run `choco push` to push the built package and make it available for download (NOTE: You will need permissions to push the package/to be authenticated. Reach out to [@danielhelfand](https://github.com/danielhelfand) for more details.)
2 changes: 1 addition & 1 deletion choco/tektoncd-cli.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
<metadata>
<id>tektoncd-cli</id>
<version>0.42.0</version>
<version>0.43.0</version>
<title>Tekton CLI (tkn)</title>
<authors>Tekton authors, see https://github.com/tektoncd/cli/graphs/contributors</authors>
<projectUrl>https://github.com/tektoncd/cli</projectUrl>
Expand Down
4 changes: 2 additions & 2 deletions choco/tools/chocolateyinstall.ps1
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
$ErrorActionPreference = 'Stop';
$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$packageName = 'tektoncd-cli'
$url64 = 'https://github.com/tektoncd/cli/releases/download/v0.42.0/tkn_0.42.0_Windows_x86_64.zip'
$url64 = 'https://github.com/tektoncd/cli/releases/download/v0.43.0/tkn_0.43.0_Windows_x86_64.zip'

$packageArgs = @{
packageName = $packageName
unzipLocation = $toolsDir
url64bit = $url64
softwareName = 'tektoncd-cli*'
checksum64 = 'd49db0ce35f4b6c38d83048e35d9eb8f286a2d251a6bd365a8124e730069ebc7'
checksum64 = 'c57dc0f0e97414a7482cb9a420d47eab85410903fabc072925edb09691f0aadc'
checksumType64 = 'sha256'
}

Expand Down
24 changes: 14 additions & 10 deletions releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ as follows:
- Four releases a year are chosen for [long term support (LTS)](https://github.com/tektoncd/community/blob/main/releases.md#support-policy).
All remaining releases are supported for approximately 1 month (until the next
release is produced)
- LTS releases take place in January, April, July and October every year
- The first Tekton CLI LTS release will be **v0.30.0** in January 2023
- Releases happen towards the middle of the month, but the exact date may vary,
depending on week-ends and readiness
- LTS releases take place in January, April, July and October every year
- The first Tekton CLI LTS release will be **v0.30.0** in January 2023
- Releases happen towards the middle of the month, but the exact date may vary,
depending on week-ends and readiness

Tekton CLI produces nightly builds, publicly available on
`gcr.io/tekton-nightly`.
`gcr.io/tekton-nightly`.

### Transition Process

Expand All @@ -36,6 +36,12 @@ Further documentation available:

## Releases

### v0.43 (LTS)

- **Latest Release**: [v0.43.0][v0-43-0] (2025-11-21) ([docs][v0-43-0-docs])
- **Initial Release**: [v0.43.0][v0-43-0] (2025-11-21) ([docs][v0-43-0-docs])
- **End of Life**: 2026-11-20

### v0.42 (LTS)

- **Latest Release**: [v0.42.0][v0-42-0] (2025-08-22) ([docs][v0-42-0-docs])
Expand Down Expand Up @@ -153,15 +159,13 @@ Further documentation available:

Older releases are EOL and available on [GitHub][tekton-cli-releases].


[release-policy]: https://github.com/tektoncd/community/blob/main/releases.md
[tekton-chains]: https://github.com/tektoncd/chains
[tekton-cli-releases]: https://github.com/tektoncd/cli/releases
[tekton-releases-docs]: tekton/README.md
[release-notes-standards]:
https://github.com/tektoncd/community/blob/main/standards.md#release-notes
[release-notes-standards]: https://github.com/tektoncd/community/blob/main/standards.md#release-notes
[tekton-release-process]: RELEASE_PROCESS.md

[v0-43-0]: https://github.com/tektoncd/cli/releases/tag/v0.43.0
[v0-42-0]: https://github.com/tektoncd/cli/releases/tag/v0.42.0
[v0-41-1]: https://github.com/tektoncd/cli/releases/tag/v0.41.1
[v0-41-0]: https://github.com/tektoncd/cli/releases/tag/v0.41.0
Expand Down Expand Up @@ -190,7 +194,7 @@ Older releases are EOL and available on [GitHub][tekton-cli-releases].
[v0-27-0]: https://github.com/tektoncd/cli/releases/tag/v0.27.0
[v0-26-0]: https://github.com/tektoncd/cli/releases/tag/v0.26.0
[v0-25-0]: https://github.com/tektoncd/cli/releases/tag/v0.25.0

[v0-43-0-docs]: https://github.com/tektoncd/cli/tree/v0.43.0/docs
[v0-42-0-docs]: https://github.com/tektoncd/cli/tree/v0.42.0/docs
[v0-41-1-docs]: https://github.com/tektoncd/cli/tree/v0.41.1/docs
[v0-41-0-docs]: https://github.com/tektoncd/cli/tree/v0.41.0/docs
Expand Down
Loading
Loading