Skip to content

Commit a6559f7

Browse files
author
Kalle Fagerberg
committed
Updated install docs & replaced mise with aqua
1 parent 81b98d7 commit a6559f7

1 file changed

Lines changed: 42 additions & 19 deletions

File tree

src/content/docs/setup/install.mdx

Lines changed: 42 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,24 @@ sidebar:
55
order: 1
66
---
77

8-
As a prerequisite, you must first [install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl).
9-
10-
:::caution
11-
Because kubecolor internally calls `kubectl` command, if you are using unsupported kubectl version, it's also not supported by kubecolor.
12-
Kubernetes version support policy can be found in [official doc](https://kubernetes.io/docs/setup/release/version-skew-policy/).
13-
:::
8+
import { Tabs, TabItem } from '@astrojs/starlight/components';
149

1510
Kubecolor can be installed in various ways through a number of package managers.
1611
If you don't have any of the package managers available, then consider [downloading the binary](#download-binary-via-github-release).
1712

18-
:::note
19-
We only add new repositories and ways to install kubecolor on demand.
20-
If you feel like your favorite package manager is missing,
21-
then please file a [feature request](https://github.com/kubecolor/kubecolor/issues/new?template=feature.yml).
22-
:::
23-
2413
*The badges below each section show the latest version available for that package repository.
2514
Green means that it's up-to-date, while red means outdated.*
2615

16+
## Prerequisites
17+
18+
As a prerequisite, you must first [install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl).
19+
Some packages listed below will install it for you. But some won't.
20+
21+
:::caution
22+
Because kubecolor internally calls `kubectl` command, if you are using unsupported kubectl version, it's also not supported by kubecolor.
23+
Kubernetes version support policy can be found in [official doc](https://kubernetes.io/docs/setup/release/version-skew-policy/).
24+
:::
25+
2726
## Homebrew
2827

2928
[![Homebrew version](https://repology.org/badge/version-for-repo/homebrew/kubecolor.svg)](https://repology.org/project/kubecolor/versions)
@@ -71,9 +70,25 @@ winget install --id Kubecolor.kubecolor
7170

7271
[![nixpkgs unstable package](https://repology.org/badge/version-for-repo/nix_unstable/kubecolor.svg)](https://repology.org/project/kubecolor/versions)
7372

74-
```sh
75-
nix-shell -p kubecolor
76-
```
73+
<Tabs>
74+
<TabItem label="nix-shell">
75+
```sh
76+
nix-shell -p kubecolor
77+
```
78+
</TabItem>
79+
<TabItem label="nix shell">
80+
```sh
81+
nix shell nixpkgs#kubecolor
82+
```
83+
</TabItem>
84+
<TabItem label="flox">
85+
[Flox](https://flox.dev/) is a package manager built on top of Nix.
86+
87+
```sh
88+
flox install kubecolor
89+
```
90+
</TabItem>
91+
</Tabs>
7792

7893
## AUR (Arch User Repositories)
7994

@@ -103,12 +118,14 @@ For users using the [asdf](https://github.com/asdf-vm/asdf) package manager.
103118
asdf install kubecolor latest
104119
```
105120

106-
## mise
121+
## aqua
122+
123+
[![aqua version](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fgithub.com%2Faquaproj%2Faqua-registry%2Fraw%2F8c9f102b42aa88fde6cc649269b57875556f9c9c%2Fpkgs%2Fkubecolor%2Fkubecolor%2Fpkg.yaml&query=%24.packages%5B0%5D.name&label=aqua&color=4cc61f)](https://github.com/aquaproj/aqua-registry/blob/main/pkgs/kubecolor/kubecolor/pkg.yaml)
107124

108-
For users using the [mise](https://github.com/jdx/mise) package manager.
125+
For users using the [aqua](https://aquaproj.github.io/) package manager.
109126

110127
```sh
111-
mise use kubecolor
128+
aqua g -i kubecolor/kubecolor
112129
```
113130

114131
## Download binary via GitHub release
@@ -128,7 +145,7 @@ go install github.com/kubecolor/kubecolor@latest
128145
Running it via Docker can be nice for just trying out kubecolor:
129146

130147
```sh
131-
docker run --rm -it -v $HOME/.kube:/home/nonroot/.kube:ro ghcr.io/kubecolor/kubecolor get pods
148+
docker run --rm -it -v $HOME/.kube:/home/nonroot/.kube:ro --env COLORTERM ghcr.io/kubecolor/kubecolor get pods
132149
```
133150

134151
:::note
@@ -145,3 +162,9 @@ chmod 644 ~/.kube/config
145162
```
146163

147164
:::
165+
166+
## Missing a repository?
167+
168+
We only add new repositories and ways to install kubecolor on demand.
169+
If you feel like your favorite package manager is missing,
170+
then please file a [feature request](https://github.com/kubecolor/kubecolor/issues/new?template=feature.yml).

0 commit comments

Comments
 (0)