Rename tk binary to gotk
To avoid conflicts with the `tk` binary from the Tanka project.
This commit is contained in:
@@ -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
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user