Skip to content

Installation

To run the Kubetail CLI tool (kubetail) inside a container you can use the kubetail-cli docker image. The image is published to Docker Hub and the GitHub Container Registry on every release:

RegistryImage
Docker Hubkubetail/kubetail-cli
GHCRghcr.io/kubetail-org/kubetail-cli

Two variants are available:

Tag suffixBase imageDescription
(none)scratchMinimal image, smallest footprint
-alpinealpineIncludes a shell and standard utilities

To use the CLI tool locally with docker run you need to mount your local .kube/config file into a kubetail-cli container:

Terminal window
docker run --rm -it \
-v ~/.kube/config:/root/.kube/config:ro \
kubetail/kubetail-cli logs \
--kubeconfig /root/.kube/config \
-f \
deployments/my-app

You can also use the sh entrypoint to start an interactive session:

Terminal window
docker run --rm -it \
-v ~/.kube/config:/root/.kube/config:ro \
--entrypoint sh \
kubetail/kubetail-cli

To use the CLI tool locally with docker-compose you can use this docker-compose.yml config file to get started:

Terminal window
curl -LO https://raw.githubusercontent.com/kubetail-org/kubetail/refs/heads/main/config/examples/docker-compose.yml
docker-compose up

This will mount your local .kube/config file into a kubetail-cli container and start the dashboard server at http://localhost:7500.

To use the CLI tool inside a cluster you can use this kubetail-cli-pod.yaml manifest file to get started:

Terminal window
kubectl add -f https://raw.githubusercontent.com/kubetail-org/kubetail/refs/heads/main/config/examples/kubetail-cli-pod.yaml

This will start a kubetail-cli container inside the default namespace with access to pod logs in the same namespace. Once the pod is running you can exec into it and run CLI commands using the --in-cluster flag:

Terminal window
kubectl exec -it kubetail-cli -- sh
# ./kubetail logs --in-cluster -f deployments/my-app