Installation Guide

Kubed is a powerful CLI tool that enhances your terminal experience when working with Docker, Kubernetes, Terraform, and Helm. This guide covers all installation options and requirements.

Requirements

Before installing Kubed, ensure you have the following prerequisites:

Python 3.6 or later
Pip (Python package installer)
Optional tools that will be installed automatically if missing:
- Docker
- Kubernetes (kubectl)
- Terraform
- Helm

Basic Installation

The simplest way to install Kubed is using pip:

pip install kubed

After installation, you’ll need to run the setup command to configure your environment:

kubed-setup

This will:

Check for required tools and offer to install any that are missing
Set up shell completions and aliases
Configure your shell environment
For zsh users, install oh-my-zsh and Powerlevel10k theme for optimal experience
For fish users, install Starship prompt for optimal experience

Non-interactive Installation

For automated deployments or scripts, you can use the --force-yes flag to automatically accept all installation prompts:

kubed-setup --force-yes

This will automatically:

Install any missing tools without prompting
Set up oh-my-zsh and Powerlevel10k for zsh users
Set up Starship for fish users
Configure your shell environment

Installation Options

The kubed-setup command accepts the following options:

Option	Description
`--zsh`	Force using ZSH configuration even if not detected
`--force-yes`	Automatically answer yes to all installation prompts

Example:

kubed-setup --zsh --force-yes

Post-Installation

IMPORTANT: After installation, you MUST either:

Restart your terminal, or

Source your shell configuration file:

source ~/.zshrc    # for zsh users
source ~/.bashrc   # for bash users
source ~/.config/fish/config.fish  # for fish users

Kubed will offer to run the source command for you during setup.

Manual Component Installation

If you prefer to install the tools manually, you can use the following commands:

Docker

brew install docker    # macOS

Kubernetes (kubectl)

brew install kubectl   # macOS

Terraform

brew install terraform # macOS

Helm

brew install helm      # macOS

Fish Shell (Recommended)

brew install fish      # macOS

Starship Prompt (for Fish)

curl -sS https://starship.rs/install.sh | sh

Troubleshooting

Missing setuptools

If you encounter errors related to pkg_resources or setuptools, install or upgrade setuptools:

pip install --upgrade setuptools

Shell Issues

If your shell isn’t properly configured after installation:

Check if the kubed setup block exists in your shell config:

grep kubed ~/.zshrc  # or ~/.bashrc or ~/.config/fish/config.fish

Manually source the configuration:

source ~/.zshrc      # or ~/.bashrc or ~/.config/fish/config.fish

Run setup again:
```
kubed-setup
```

Contact Support

For additional help, please open an issue or contact support at daleyarborough@gmail.com.