1
0
mirror of synced 2026-02-13 13:06:56 +00:00

Rename tk binary to gotk

To avoid conflicts with the `tk` binary from the Tanka project.
This commit is contained in:
Hidde Beydals
2020-08-25 21:09:34 +02:00
parent cb23d3ff3c
commit 22624ae4d5
108 changed files with 500 additions and 500 deletions

View File

@@ -1,4 +1,4 @@
# TK CLI Installation
# GOTK CLI Installation
Binaries for macOS and Linux AMD64 are available for download on the
[release page](https://github.com/fluxcd/toolkit/releases).
@@ -6,19 +6,19 @@ Binaries for macOS and Linux AMD64 are available for download on the
To install the latest release run:
```bash
curl -s https://raw.githubusercontent.com/fluxcd/toolkit/master/install/tk.sh | sudo bash
curl -s https://raw.githubusercontent.com/fluxcd/toolkit/master/install/gotk.sh | sudo bash
```
The install script does the following:
* attempts to detect your OS
* downloads and unpacks the release tar file in a temporary directory
* copies the tk binary to `/usr/local/bin`
* copies the gotk binary to `/usr/local/bin`
* removes the temporary directory
If you want to use tk as a kubectl plugin, rename the binary to `kubectl-tk`:
If you want to use gotk as a kubectl plugin, rename the binary to `kubectl-gotk`:
```sh
mv /usr/local/bin/tk /usr/local/bin/kubectl-tk
mv /usr/local/bin/gotk /usr/local/bin/kubectl-gotk
```
## Build from source
@@ -30,7 +30,7 @@ git clone https://github.com/fluxcd/toolkit
cd toolkit
```
Build the tk binary (requires go >= 1.14):
Build the `gotk` binary (requires go >= 1.14):
```bash
make build
@@ -39,5 +39,5 @@ make build
Run the binary:
```bash
./bin/tk -h
./bin/gotk -h
```